svn commit: r1675263 - /jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md

[th...@apache.org]

Author: thomasm
Date: Wed Apr 22 06:39:44 2015
New Revision: 1675263

URL: http://svn.apache.org/r1675263
Log:
OAK-301 : oak docu

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=1675263&r1=1675262&r2=1675263&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 Apr 22 06:39:44 2015
@@ -122,11 +122,18 @@ name
 : Optional property
 : Captures the name of the index which is used while logging
 
-compatMode
+compatVersion
 : Required integer property and should be set to 2
 : By default Oak uses older Lucene index implementation which does not
-  supports property restrictions, index time aggregation etc. To make use of
-  this feature set it to 2
+  supports property restrictions, index time aggregation etc. 
+  To make use of this feature set it to 2.
+  Please note for full text indexing with compatVersion 2, 
+  at query time, only the access right of the parent (aggregate) node is checked, 
+  and the access right of the child nodes is not checked.
+  If this is a security concern, then compatVersion should not be set,
+  so that query time aggregation is used, in which case the access right
+  of the relevant child is also checked.
+  A compatVersion 2 full text index is usually faster to run queries.
 
 [maxFieldLength][OAK-2469]
 : Numbers of terms indexed per field. Defaults to 10000