Author: mreutegg
Date: Tue Mar 1 10:07:19 2016
New Revision: 1733024
URL: http://svn.apache.org/viewvc?rev=1733024&view=rev
Log:
OAK-301: Document Oak
Add code sample how to create a TarMK based repository
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/construct.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/construct.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/construct.md?rev=1733024&r1=1733023&r2=1733024&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/construct.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/construct.md Tue Mar 1
10:07:19 2016
@@ -29,6 +29,11 @@ To construct an in-memory repository, us
Repository repo = new Jcr(new Oak()).createRepository();
+To use a tar file based Segment NodeStore backend, use:
+
+ FileStore fs = FileStore.newFileStore(new File("repository")).create();
+ Repository repo = new Jcr(new SegmentNodeStore(fs)).createRepository();
+
To use a MongoDB backend, use:
DB db = new MongoClient("127.0.0.1", 27017).getDB("test2");
@@ -36,7 +41,7 @@ To use a MongoDB backend, use:
setMongoDB(db).getNodeStore();
Repository repo = new Jcr(new Oak(ns)).createRepository();
-To login to the repository and do some work (using
+To login to the repository and do some work (using
the default username/password combination), use:
Session session = repo.login(
@@ -56,4 +61,8 @@ the default username/password combinatio
To logout and close the backend store, use:
session.logout();
+ // depending on NodeStore implementation either:
+ // close FileStore
+ fs.close();
+ // or close DocumentNodeStore
ns.dispose();
