Author: rombert
Date: Tue Feb 13 12:34:41 2018
New Revision: 1824121
URL: http://svn.apache.org/viewvc?rev=1824121&view=rev
Log:
Improve the composite node store documentation a bit
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/compositens.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/compositens.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/compositens.md?rev=1824121&r1=1824120&r2=1824121&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/compositens.md
(original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/nodestore/compositens.md Tue
Feb 13 12:34:41 2018
@@ -16,7 +16,21 @@
-->
# Oak Composite NodeStore
-**The documentation and the Composite NodeStore implementation are a
work-in-progress. Please ask on oak-dev for things that are missing or
unclear.**
+**The documentation of the Composite NodeStore implementation is
work-in-progress. Please ask on oak-dev for things that are missing or
unclear.**
+
+## Overview
+
+The `CompositeNodeStore` is a `NodeStore` implementation that wraps multiple
`NodeStore` instances
+and exposes them through a single API. It is possible, for instance, to store
all data in a
+`DocumentNodeStore` instance and relocate `/libs` and `/apps` in a
`SegmentNodeStore` instance.
+
+Each node stored wrapped by the composite node store instance is called a
_mount_.
+
+## Design limitations
+
+The implementation allows for a default mount, which is read-write, and for
any number of
+additional mounts, which are read-only. This limitation is by design and is
not expected to
+be removed in future Oak version.
## Checking for read-only access
@@ -24,4 +38,4 @@ The Composite NodeStore mounts various o
is not enfored via permissions, it may not be queried via
`Session.hasPermission`. Instead, the
read-only status is surfaced via `Session.hasCapability`. See
[OAK-6563][OAK-6563] for details.
-[OAK-6563]: https://issues.apache.org/jira/browse/OAK-6563
\ No newline at end of file
+[OAK-6563]: https://issues.apache.org/jira/browse/OAK-6563
