Author: catholicon
Date: Wed Jun 29 15:20:27 2016
New Revision: 1750665
URL: http://svn.apache.org/viewvc?rev=1750665&view=rev
Log:
OAK-4517: Document excluded/included/queryPaths for sub root lucene index
definitions
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md?rev=1750665&r1=1750664&r2=1750665&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md Wed Jun 29
15:20:27 2016
@@ -463,6 +463,13 @@ Key points to consider while using `excl
So only exclude those paths which do not have node matching given nodeType
or nodes which
are known to be not part of any query result
+4. Sub-root index definitions (e.g. `/test/oak:index/index-def-node`) -
+ `excludedPaths` and `includedPaths` need to be relative to the path that
index is defined
+ for. e.g. if the condition is supposed to be put for `/test/a` where the
index definition
+ is at `/test/oak:index/index-def-node` then `/a` needs to be put as value
of `excludedPaths`
+ or `includedPaths`. On the other hand, `queryPaths` remains to be an
absolute path. So, for
+ the example above, `queryPaths` would get the value `/test/a`.
+
In most cases use of `queryPaths` would not be required as index definition
should not have
any overlap.
