You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by th...@apache.org on 2015/09/01 11:20:11 UTC
svn commit: r1700434 -
/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md
Author: thomasm
Date: Tue Sep 1 09:20:11 2015
New Revision: 1700434
URL: http://svn.apache.org/r1700434
Log:
OAK-301: Document Oak
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md?rev=1700434&r1=1700433&r2=1700434&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md Tue Sep 1 09:20:11 2015
@@ -266,6 +266,14 @@ To define a property index on a subtree
This is a multi-valued property, and must not be empty.
It usually contains only _one_ property name.
All nodes that have _any_ of those properties are stored in this index.
+* `includePaths` (String, multi-valued):
+ the paths that are included ('/' if not set).
+ The index is only used if the query has a path restriction that is not excluded,
+ and part of the included paths.
+* `excludePaths` (String, multi-valued):
+ the paths where this index is excluded (none if not set).
+ The index is only used if the query has a path restriction that is not excluded,
+ and part of the included paths.
It is recommended to index one property per index.
(If multiple properties are indexed within one index,