Author: sseifert
Date: Tue Sep 15 22:03:21 2015
New Revision: 1703300
URL: http://svn.apache.org/r1703300
Log:
SLING-4381/SLING-5024 nosql resource provider documentation
Modified:
sling/site/trunk/content/documentation/bundles/nosql-resource-providers.mdtext
Modified:
sling/site/trunk/content/documentation/bundles/nosql-resource-providers.mdtext
URL:
http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/bundles/nosql-resource-providers.mdtext?rev=1703300&r1=1703299&r2=1703300&view=diff
==============================================================================
---
sling/site/trunk/content/documentation/bundles/nosql-resource-providers.mdtext
(original)
+++
sling/site/trunk/content/documentation/bundles/nosql-resource-providers.mdtext
Tue Sep 15 22:03:21 2015
@@ -15,7 +15,7 @@ The general concept of retrieving from a
* The Sling CRUD support defines a simple transaction model with buffering all
changes in memory until a call to "commit()" persists them to the NoSQL database
* Iterating over child resources and deleting a resource including all
descendants requires some basic query capabilities in the NoSQL store
-All these general features are implemented in an abstraction layer called
["Apache Sling NoSQL Generic Resource
Provider"](https://svn.apache.org/repos/asf/sling/trunk/contrib/nosql/generic),
which is used by the resource provider implementations per NoSQL product. Those
implementation than only implement a thin "adapter" which maps the resource
data to the NoSQL product-specific storage formats and query capabilities,
without having to care about all the complex resource provider handling.
+All these general features are implemented in an abstraction layer called
["Apache Sling NoSQL Generic Resource
Provider"](https://github.com/apache/sling/tree/trunk/contrib/nosql/generic),
which is used by the resource provider implementations per NoSQL product. Those
implementation than only implement a thin "adapter" which maps the resource
data to the NoSQL product-specific storage formats and query capabilities,
without having to care about all the complex resource provider handling.
This generic resource provider also contains a set of integration tests
covering the most relevant resource read- and write usecases which can be used
to test a NoSQL product-specific resource provider implementation and the
underlying NoSQL database.
@@ -28,19 +28,17 @@ Tested with MongoDB Server 3.0.6 and Mon
Configuration example:
-```
org.apache.sling.nosql.mongodb.resourceprovider.MongoDBNoSqlResourceProviderFactory.factory.config-default
provider.roots=["/"]
connectionString="localhost:27017"
database="sling"
collection="resources"
-```
See Apache Felix OSGi console for detailed documentation of the parameters.
All resource data is stored in one Collection of one MongoDB database. Each
resource is stored as a document with the path stored in an "_id" property.
-Source code: [Apache Sling NoSQL MongoDB Resource
Provider](https://svn.apache.org/repos/asf/sling/trunk/contrib/nosql/mongodb-resourceprovider)
+Source code: [Apache Sling NoSQL MongoDB Resource
Provider](https://github.com/apache/sling/tree/trunk/contrib/nosql/mongodb-resourceprovider)
-Please note: there is an [alternative MongoDB resource provider
implementation](https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/mongodb)
from 2012 which has less features, a slightly different concept for storing
resource data (in multiple collections), and it does not use the "Generic
Resource Provider".
+Please note: there is an [alternative MongoDB resource provider
implementation](https://github.com/apache/sling/tree/trunk/contrib/extensions/mongodb)
from 2012 which has less features, a slightly different concept for storing
resource data (in multiple collections), and it does not use the "Generic
Resource Provider".
## Couchbase NoSQL Resource Provider
@@ -51,7 +49,6 @@ Tested with Couchbase Server 4.0.0-rc0 a
Configuration example:
-```
org.apache.sling.nosql.couchbase.resourceprovider.CouchbaseNoSqlResourceProviderFactory.factory.config-default
provider.roots=["/"]
@@ -60,10 +57,9 @@ Configuration example:
couchbaseHosts="localhost:8091"
bucketName="sling"
enabled=B"true"
- ```
See Apache Felix OSGi console for detailed documentation of the parameters.
All resource data is stored in one Couchbase bucket. Each resource is stored as
a document with the path as key.
-Source code: [Apache Sling NoSQL Couchbase Resource
Provider](https://svn.apache.org/repos/asf/sling/trunk/contrib/nosql/couchbase-resourceprovider)
+Source code: [Apache Sling NoSQL Couchbase Resource
Provider](https://github.com/apache/sling/tree/trunk/contrib/nosql/couchbase-resourceprovider)
-The resource provider requires and additional bundle [Apache Sling NoSQL
Couchbase
Client](https://svn.apache.org/repos/asf/sling/trunk/contrib/nosql/couchbase-client)
which wraps the Couchbase Java SDK (which itself is not an OSGi bundle), and
ensures that the Couchbase Environment instance is used as a singleton in the
VM.
+The resource provider requires and additional bundle [Apache Sling NoSQL
Couchbase
Client](https://github.com/apache/sling/tree/trunk/contrib/nosql/couchbase-client)
which wraps the Couchbase Java SDK (which itself is not an OSGi bundle), and
ensures that the Couchbase Environment instance is used as a singleton in the
VM.
