diff --git a/src/docbkx/index.xml b/src/docbkx/index.xml index e41b48f26..2c1f663c2 100644 --- a/src/docbkx/index.xml +++ b/src/docbkx/index.xml @@ -5,26 +5,28 @@ Spring Datastore Document - Reference Documentation - version; + &version; Mark - Pollack Thomas - Risberg Oliver - Gierke + + Costin + Leau + SpringSource + @@ -38,15 +40,21 @@ - - - Reference - - - This part of the reference documentation details the ... - - - + + Introduction + + + + + + + + Reference Documentation + + + + + \ No newline at end of file diff --git a/src/docbkx/introduction/getting-started.xml b/src/docbkx/introduction/getting-started.xml new file mode 100644 index 000000000..c15172dd3 --- /dev/null +++ b/src/docbkx/introduction/getting-started.xml @@ -0,0 +1,112 @@ + + + + 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. + +
+ First Steps + + As explained in , Spring Data Document (SDDOC) 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 SDDOC 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 SDDOC. + 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 SDDOC 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. + +
+
+ +
+ 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 diff --git a/src/docbkx/introduction/introduction.xml b/src/docbkx/introduction/introduction.xml new file mode 100644 index 000000000..fd60d7787 --- /dev/null +++ b/src/docbkx/introduction/introduction.xml @@ -0,0 +1,17 @@ + + + + + + This document is the reference guide for Spring Data - Document Support. + It explains Document module concepts and semantics and the syntax for various + stores namespaces. + + For an introduction to document stores or Spring, or Spring Data examples, please refer to + - this documentation refers only to Spring Data Document Support and + assumes the user is familiar with the document stores and Spring concepts. + + + + \ No newline at end of file diff --git a/src/docbkx/introduction/requirements.xml b/src/docbkx/introduction/requirements.xml new file mode 100644 index 000000000..581d20be5 --- /dev/null +++ b/src/docbkx/introduction/requirements.xml @@ -0,0 +1,11 @@ + + Requirements + + Spring Data Document 1.x binaries requires JDK level 6.0 and above, + and Spring Framework + 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. + + \ No newline at end of file diff --git a/src/docbkx/introduction/why-sd-doc.xml b/src/docbkx/introduction/why-sd-doc.xml new file mode 100644 index 000000000..dde545bd0 --- /dev/null +++ b/src/docbkx/introduction/why-sd-doc.xml @@ -0,0 +1,21 @@ + + + + Why Spring Data - Document? + + The Spring Framework is the leading full-stack Java/JEE + application framework. It provides a lightweight container and a + non-invasive programming model enabled by the use of dependency + injection, AOP, and portable service abstractions. + + NoSQL + storages provide an alternative to classical RDBMS for horizontal scalability + and speed. In terms of implementation, Document stores represent one of the + most popular types of stores in the NoSQL space. + + The Spring Data Document (or SDDOC) framework makes it easy to + write Spring applications that use a Document store by eliminating the redundant + tasks and boiler place code required for interacting with the store through + Spring's excellent infrastructure support. + \ No newline at end of file diff --git a/src/docbkx/reference/introduction.xml b/src/docbkx/reference/introduction.xml new file mode 100644 index 000000000..d65374931 --- /dev/null +++ b/src/docbkx/reference/introduction.xml @@ -0,0 +1,9 @@ + + Document structure + + This part of the reference documentation explains the core functionality + offered by Spring Data Document. + + introduces the Document module feature set. + + \ No newline at end of file diff --git a/src/docbkx/reference/mongodb.xml b/src/docbkx/reference/mongodb.xml new file mode 100644 index 000000000..fac9f1d9f --- /dev/null +++ b/src/docbkx/reference/mongodb.xml @@ -0,0 +1,94 @@ + + + + MongoDB support + + One of the document stores supported by SDDOC is MongoDB. + To quote the project home page: + + MongoDB (from "humongous") is a scalable, high-performance, open source, document-oriented database. + + + Spring Data Document provides easy configuration and access to MongoDB from a Spring application. Offers both low-level and + high-level abstraction for interacting with the store, freeing the user from infrastructural concerns. + + +
+ MongoDB Requirements + SDDOC requires MongoDB 1.4 while 1.6 is recommended. + +
+ +
+ MongoDB Support High Level View + + The MongoDB support provides several components: + + Configuration Factory - for configuring and handling communication with MongoDB via its Java driver + 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 are the best choice. Note that at any point, one can move between layers - for example, it's very + easy to get a hold of the low level connection (org.mongo.DB) to communicate directly with MongoDB. +
+ +
+ Connecting to MongoDB + + One of the first tasks when using MongoDB and Spring is to connect to the store through the IoC container. To do that + + The easiest way to work with a MongoFactoryBean is to configure ... + +
+ +
+ Working with Objects through <classname>MongoTemplate</classname> + + Most users are likely to use MongoTemplate and its corresponding package 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 a high-level abstraction for MongoDB interaction. + + + + Operational views + + + + + + + + Interface + Description + + + + + Collection Operations + MongoDB string (or value) operations + + + Document Operations + MongoDB list 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... + +
+ +
+ 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 mentioned above, we are interested in hearing from you! +
+ \ No newline at end of file diff --git a/src/docbkx/resources/images/admons/blank.png b/src/docbkx/resources/images/admons/blank.png new file mode 100644 index 000000000..764bf4f0c Binary files /dev/null and b/src/docbkx/resources/images/admons/blank.png differ diff --git a/src/docbkx/resources/images/admons/caution.gif b/src/docbkx/resources/images/admons/caution.gif new file mode 100644 index 000000000..d9f5e5b1b Binary files /dev/null and b/src/docbkx/resources/images/admons/caution.gif differ diff --git a/src/docbkx/resources/images/admons/caution.png b/src/docbkx/resources/images/admons/caution.png new file mode 100644 index 000000000..5b7809ca4 Binary files /dev/null and b/src/docbkx/resources/images/admons/caution.png differ diff --git a/src/docbkx/resources/images/admons/caution.tif b/src/docbkx/resources/images/admons/caution.tif new file mode 100644 index 000000000..4a282948c Binary files /dev/null and b/src/docbkx/resources/images/admons/caution.tif differ diff --git a/src/docbkx/resources/images/admons/draft.png b/src/docbkx/resources/images/admons/draft.png new file mode 100644 index 000000000..0084708c9 Binary files /dev/null and b/src/docbkx/resources/images/admons/draft.png differ diff --git a/src/docbkx/resources/images/admons/home.gif b/src/docbkx/resources/images/admons/home.gif new file mode 100644 index 000000000..6784f5bb0 Binary files /dev/null and b/src/docbkx/resources/images/admons/home.gif differ diff --git a/src/docbkx/resources/images/admons/home.png b/src/docbkx/resources/images/admons/home.png new file mode 100644 index 000000000..cbb711de7 Binary files /dev/null and b/src/docbkx/resources/images/admons/home.png differ diff --git a/src/docbkx/resources/images/admons/important.gif b/src/docbkx/resources/images/admons/important.gif new file mode 100644 index 000000000..6795d9a81 Binary files /dev/null and b/src/docbkx/resources/images/admons/important.gif differ diff --git a/src/docbkx/resources/images/admons/important.png b/src/docbkx/resources/images/admons/important.png new file mode 100644 index 000000000..ad57f6f72 Binary files /dev/null and b/src/docbkx/resources/images/admons/important.png differ diff --git a/src/docbkx/resources/images/admons/important.tif b/src/docbkx/resources/images/admons/important.tif new file mode 100644 index 000000000..184de6371 Binary files /dev/null and b/src/docbkx/resources/images/admons/important.tif differ diff --git a/src/docbkx/resources/images/admons/next.gif b/src/docbkx/resources/images/admons/next.gif new file mode 100644 index 000000000..aa1516e69 Binary files /dev/null and b/src/docbkx/resources/images/admons/next.gif differ diff --git a/src/docbkx/resources/images/admons/next.png b/src/docbkx/resources/images/admons/next.png new file mode 100644 index 000000000..45835bf89 Binary files /dev/null and b/src/docbkx/resources/images/admons/next.png differ diff --git a/src/docbkx/resources/images/admons/note.gif b/src/docbkx/resources/images/admons/note.gif new file mode 100644 index 000000000..f329d359e Binary files /dev/null and b/src/docbkx/resources/images/admons/note.gif differ diff --git a/src/docbkx/resources/images/admons/note.png b/src/docbkx/resources/images/admons/note.png new file mode 100644 index 000000000..ad57f6f72 Binary files /dev/null and b/src/docbkx/resources/images/admons/note.png differ diff --git a/src/docbkx/resources/images/admons/note.tif b/src/docbkx/resources/images/admons/note.tif new file mode 100644 index 000000000..08644d6b5 Binary files /dev/null and b/src/docbkx/resources/images/admons/note.tif differ diff --git a/src/docbkx/resources/images/admons/prev.gif b/src/docbkx/resources/images/admons/prev.gif new file mode 100644 index 000000000..64ca8f3c7 Binary files /dev/null and b/src/docbkx/resources/images/admons/prev.gif differ diff --git a/src/docbkx/resources/images/admons/prev.png b/src/docbkx/resources/images/admons/prev.png new file mode 100644 index 000000000..cf24654f8 Binary files /dev/null and b/src/docbkx/resources/images/admons/prev.png differ diff --git a/src/docbkx/resources/images/admons/tip.gif b/src/docbkx/resources/images/admons/tip.gif new file mode 100644 index 000000000..823f2b417 Binary files /dev/null and b/src/docbkx/resources/images/admons/tip.gif differ diff --git a/src/docbkx/resources/images/admons/tip.png b/src/docbkx/resources/images/admons/tip.png new file mode 100644 index 000000000..ad57f6f72 Binary files /dev/null and b/src/docbkx/resources/images/admons/tip.png differ diff --git a/src/docbkx/resources/images/admons/tip.tif b/src/docbkx/resources/images/admons/tip.tif new file mode 100644 index 000000000..4a3d8c75f Binary files /dev/null and b/src/docbkx/resources/images/admons/tip.tif differ diff --git a/src/docbkx/resources/images/admons/toc-blank.png b/src/docbkx/resources/images/admons/toc-blank.png new file mode 100644 index 000000000..6ffad17a0 Binary files /dev/null and b/src/docbkx/resources/images/admons/toc-blank.png differ diff --git a/src/docbkx/resources/images/admons/toc-minus.png b/src/docbkx/resources/images/admons/toc-minus.png new file mode 100644 index 000000000..abbb020c8 Binary files /dev/null and b/src/docbkx/resources/images/admons/toc-minus.png differ diff --git a/src/docbkx/resources/images/admons/toc-plus.png b/src/docbkx/resources/images/admons/toc-plus.png new file mode 100644 index 000000000..941312ce0 Binary files /dev/null and b/src/docbkx/resources/images/admons/toc-plus.png differ diff --git a/src/docbkx/resources/images/admons/up.gif b/src/docbkx/resources/images/admons/up.gif new file mode 100644 index 000000000..aabc2d016 Binary files /dev/null and b/src/docbkx/resources/images/admons/up.gif differ diff --git a/src/docbkx/resources/images/admons/up.png b/src/docbkx/resources/images/admons/up.png new file mode 100644 index 000000000..07634de26 Binary files /dev/null and b/src/docbkx/resources/images/admons/up.png differ diff --git a/src/docbkx/resources/images/admons/warning.gif b/src/docbkx/resources/images/admons/warning.gif new file mode 100644 index 000000000..c6acdec60 Binary files /dev/null and b/src/docbkx/resources/images/admons/warning.gif differ diff --git a/src/docbkx/resources/images/admons/warning.png b/src/docbkx/resources/images/admons/warning.png new file mode 100644 index 000000000..ef3e10f40 Binary files /dev/null and b/src/docbkx/resources/images/admons/warning.png differ diff --git a/src/docbkx/resources/images/admons/warning.tif b/src/docbkx/resources/images/admons/warning.tif new file mode 100644 index 000000000..7b6611ec7 Binary files /dev/null and b/src/docbkx/resources/images/admons/warning.tif differ