Author: sseifert
Date: Tue Sep 15 22:01:54 2015
New Revision: 1703299
URL: http://svn.apache.org/r1703299
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=1703299&r1=1703298&r2=1703299&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:01:54 2015
@@ -29,7 +29,7 @@ Tested with MongoDB Server 3.0.6 and Mon
Configuration example:
```
-
org.apache.sling.nosql.mongodb.resourceprovider.MongoDBNoSqlResourceProviderFactory.factory.config
+
org.apache.sling.nosql.mongodb.resourceprovider.MongoDBNoSqlResourceProviderFactory.factory.config-default
provider.roots=["/"]
connectionString="localhost:27017"
database="sling"
@@ -45,9 +45,25 @@ Please note: there is an [alternative Mo
## Couchbase NoSQL Resource Provider
-tbd.
+Resource provider for [Couchbase](http://www.couchbase.com/) NoSQL database.
+Tested with Couchbase Server 4.0.0-rc0 and MongoDB Java SDK 2.2.0. Please
note: Couchbase 4 or higher is mandatory because N1QL support is required.
-## Writing your own NoSQL Resource Provider
+Configuration example:
+
+```
+
org.apache.sling.nosql.couchbase.resourceprovider.CouchbaseNoSqlResourceProviderFactory.factory.config-default
+ provider.roots=["/"]
+
+
org.apache.sling.nosql.couchbase.client.CouchbaseClient.factory.config-default
+ clientId="sling-resourceprovider-couchbase"
+ 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)
-tbd.
+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.
