diff --git a/src/docbkx/introduction/getting-started.xml b/src/docbkx/introduction/getting-started.xml index d292e7c98..2017f7d21 100644 --- a/src/docbkx/introduction/getting-started.xml +++ b/src/docbkx/introduction/getting-started.xml @@ -1,112 +1,123 @@ +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> - Getting Started + Getting Started - Learning a new framework is not always straight forward. In this section, we (the Spring Data team) - tried to provide, what we think is, an easy to follow guide for starting with Spring Data Document module. - Of course, feel free to create your own learning 'path' as you see fit and, if possible, please report back - any improvements to the documentation that can help others. + Learning a new framework is not always straight forward. In this + section, we (the Spring Data team) tried to provide, what we think is, an + easy to follow guide for starting with Spring Data Document module. Of + course, feel free to create your own learning 'path' as you see fit and, if + possible, please report back any improvements to the documentation that can + help others. -
- First Steps - - As explained in , Spring Data Document (DATADOC) provides integration - between Spring framework and document oriented data stores. Thus, it is important to become acquainted with both of these - frameworks (storages or environments depending on how you want to name them). Throughout the DATADOC documentation, - each section provides links to resources relevant however, it is best to become familiar with these topics beforehand. - -
- Knowing Spring - Spring Data uses heavily Spring framework's core functionality, - such as the IoC container, - resource abstract or - AOP infrastructure. While it is not important - to know the Spring APIs, understanding the concepts behind them is. At a minimum, the idea behind IoC should be familiar. - These being said, the more knowledge one has about the Spring, the faster she will pick up Spring Data Document. - Besides the very comprehensive (and sometimes disarming) documentation that explains in detail the Spring Framework, - there are a lot of articles, blog entries and books on the matter - take a look at the Spring framework - home page for more information. In general, this should be the starting point for - developers wanting to try Spring Data Document. -
-
- Knowing NoSQL and Document stores - NoSQL stores have taken the storage world by storm. It is a vast domain with a plethora of solutions, terms and patterns (to make things worth even the - term itself has multiple meanings). - While some of the principles are common, it is crucial that the user is familiar to some degree with the stores supported by DATADOC. - The best way to get acquainted to this solutions is to read their documentation and follow their examples - it usually doesn't take more then 5-10 minutes - to go through them and if you are coming from an RDMBS-only background many times these exercises can be an eye opener. - -
-
- Trying Out The Samples - Unfortunately the DATADOC project is very young and there are no samples available yet. However we are working on them and plan to make them available - as soon as possible. In the meantime however, one can use our test suite as a code example (assuming the documentation is not enough) - we provide extensive - integration tests for our code base. - - -
-
- -
- Need Help? - - If you encounter issues or you are just looking for an advice, feel free to use one of the links below: - -
- Community Forum - The Spring Data forum is a message board for all Spring Data (not just Document) users to - share information and help each other. Note that registration is needed only for posting. - -
-
- Professional Support - Professional, from-the-source support, with guaranteed response time, is available from SpringSource, - the company behind Spring Data and Spring. - -
+
+ First Steps + + As explained in , Spring + Data Document (DATADOC) provides integration between Spring framework and + document oriented data stores. Thus, it is important to become acquainted + with both of these frameworks (storages or environments depending on how + you want to name them). Throughout the DATADOC documentation, each section + provides links to resources relevant however, it is best to become + familiar with these topics beforehand. + +
+ Knowing Spring + + Spring Data uses heavily Spring framework's core + functionality, such as the IoC + container, resource + abstract or AOP + infrastructure. While it is not important to know the Spring APIs, + understanding the concepts behind them is. At a minimum, the idea behind + IoC should be familiar. These being said, the more knowledge one has + about the Spring, the faster she will pick up Spring Data Document. + Besides the very comprehensive (and sometimes disarming) documentation + that explains in detail the Spring Framework, there are a lot of + articles, blog entries and books on the matter - take a look at the + Spring framework home page for + more information. In general, this should be the starting point for + developers wanting to try Spring Data Document.
- -
- Following Development - - For information on the Spring Data source code repository, nightly builds and snapshot artifacts please see the Spring Data home - page. - - You can help make Spring Data best serve the needs of the Spring community by interacting with developers through the Spring Community - forums. - If you encounter a bug or want to suggest an improvement, - please create a ticket on the Spring Data issue tracker. - To stay up to date with the latest news and announcements in the Spring eco system, subscribe to the - Spring Community Portal. - Lastly, you can follow the SpringSource Data blog or the project team on Twitter - (SpringData) -
- - \ No newline at end of file + +
+ Knowing NoSQL and Document stores + + NoSQL stores have taken the storage world by storm. It is a vast + domain with a plethora of solutions, terms and patterns (to make things + worth even the term itself has multiple meanings). + While some of the principles are common, it is crucial that the user is + familiar to some degree with the stores supported by DATADOC. The best + way to get acquainted to this solutions is to read their documentation + and follow their examples - it usually doesn't take more then 5-10 + minutes to go through them and if you are coming from an RDMBS-only + background many times these exercises can be an eye opener. +
+ +
+ Trying Out The Samples + + The DATADOC project is very young but there are some samples + available in the GitHub repository: https://github.com/SpringSource/spring-data-document-examples. +
+
+ +
+ Need Help? + + If you encounter issues or you are just looking for an advice, feel + free to use one of the links below: + +
+ Community Forum + + The Spring Data forum + is a message board for all Spring Data (not just Document) users to + share information and help each other. Note that registration is needed + only for posting. +
+ +
+ Professional Support + + Professional, from-the-source support, with guaranteed response + time, is available from SpringSource, the company + behind Spring Data and Spring. +
+
+ +
+ Following Development + + For information on the Spring Data source code repository, nightly + builds and snapshot artifacts please see the Spring Data home page. + + You can help make Spring Data best serve the needs of the Spring + community by interacting with developers through the Spring Community + forums. + + If you encounter a bug or want to suggest an improvement, please + create a ticket on the Spring Data issue tracker. + + To stay up to date with the latest news and announcements in the + Spring eco system, subscribe to the Spring Community Portal. + + Lastly, you can follow the SpringSource Data blog or + the project team on Twitter (SpringData) +
+ diff --git a/src/docbkx/introduction/requirements.xml b/src/docbkx/introduction/requirements.xml index 581d20be5..9fa620544 100644 --- a/src/docbkx/introduction/requirements.xml +++ b/src/docbkx/introduction/requirements.xml @@ -6,6 +6,6 @@ 3.0.x and above. In terms of document stores, MongoDB preferably version 1.6.5 - and CouchDB 1.0.1 or later are required. + or later or CouchDB 1.0.1 or later are required. \ No newline at end of file diff --git a/src/docbkx/preface.xml b/src/docbkx/preface.xml index a9a31255e..89010a73e 100644 --- a/src/docbkx/preface.xml +++ b/src/docbkx/preface.xml @@ -4,8 +4,9 @@ Preface - The Spring Datastore Document project applies core Spring concepts to the development of solutions using a document style data store. - We provide a "template" as a high-level abstraction for sending and receiving messages. - You will notice similarities to the JDBC support in the Spring Framework. - + The Spring Datastore Document project applies core Spring concepts to + the development of solutions using a document style data store. We provide a + "template" as a high-level abstraction for storing and querying documents. + You will notice similarities to the JDBC support in the Spring + Framework. diff --git a/src/docbkx/reference/mongodb.xml b/src/docbkx/reference/mongodb.xml index 60a1f8f98..dfdf5cb1e 100644 --- a/src/docbkx/reference/mongodb.xml +++ b/src/docbkx/reference/mongodb.xml @@ -1,7 +1,7 @@ - + Core support One of the document stores supported by DATADOC is The MongoDB support provides several components: - Configuration Factory - for configuring - and handling communication with MongoDB via its Java driver + + Configuration Factory - Template implemenattion - providing a - generified, user friendly template classes for interacting with MongoDB. - explains the abstraction builds on - top of the low-level MongoDB Java API to handle the storage and - retrieval of documents plus mapping between documents and domain - classes. + - for configuring and handling communication with MongoDB via its Java driver + - Support Classes - that offer reusable - components such as mapping support and exception translation. + + Template implemenattion + + - providing a generified, user friendly template classes for interacting with MongoDB. + + + + explains the abstraction builds on top of the low-level MongoDB Java API to handle the storage and retrieval of documents plus mapping between documents and domain classes. + + + + Support Classes + + - that offer reusable components such as mapping support and exception translation. + For most tasks, the higher-level abstractions and support services @@ -122,7 +131,7 @@ public class AppConfig {
- Working with Objects through + <title>Working with objects through <classname>MongoTemplate</classname> Most users are likely to use MongoTemplate @@ -130,62 +139,24 @@ public class AppConfig { org.springframework.data.document.mongodb - the template is in fact the central class of the MongoDB module due to its rich feature set. The template offers convenience methods and automatic - mapping between MongoDB JSON documents and your domain classes. + mapping between MongoDB JSON documents and your domain classes. Out of the + box, MongoTemplate uses a Java-based default + converter but you can also write your own converter classes to be used for + reading and storing domain objects. Once configured, the template is + thread-safe and can be reused across multiple instances. - - Operational views - - - - - - - - - - - Interface - - Description - - - - - - - Collection Operations - - - MongoDB document operations - - - - - Document Operations - - - MongoDB collection operations - - - -
- - Once configured, the template is thread-safe and can be reused - across multiple instances. - - Out of the box, MongoTemplate uses a - Java-based default converter for most of its operations... + Let's look at a couple of examples for how to interect with the + MongoTemplate.
Roadmap ahead - Spring Data MongoDB project is in its early stages. We are - interested in feedback, knowing what your use cases are, what are the - common patters you encounter so that the MongoDB module better serves your - needs. Do contact us using the channels The Spring Data Document projects MongoDB support is in its early + stages. We are interested in feedback, knowing what your use cases are, + what are the common patters you encounter so that the MongoDB module + better serves your needs. Do contact us using the channels mentioned above, we are interested in hearing from you!
- \ No newline at end of file +