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

[ch...@apache.org]

Author: chetanm
Date: Thu Sep  3 11:33:36 2015
New Revision: 1700991

URL: http://svn.apache.org/r1700991
Log:
OAK-1752 - Node name queries should use an index

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=1700991&r1=1700990&r2=1700991&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 Thu Sep  3 11:33:36 2015
@@ -191,6 +191,7 @@ definition structure
 
     ruleName (nt:unstructured)
       - inherited (boolean) = true
+      - indexNodeName (boolean) = false
       - includePropertyTypes (string) multiple
       + properties (nt:unstructured)
 
@@ -207,6 +208,19 @@ includePropertyTypes
 : For full text index defaults to include all types
 : String array of property types which should be indexed. The values can be one
   specified in [PropertyType Names][1]
+  
+<a name="index-node-name"></a>  
+indexNodeName
+: `@since Oak 1.0.20, 1.2.5`
+: Default to false. If set to true then index would also be created for node name.
+  This would enable faster evaluation of queries involving constraints on Node 
+  name. For example
+    * _select [jcr:path] from [nt:base] where NAME() = 'kite'_
+    * _select [jcr:path] from [nt:base] where NAME() LIKE 'kite%'_
+    * //kite
+    * //*[jcr:like(fn:name(), 'kite%')]
+    * //element(*, app:Asset)[fn:name() = 'kite'] 
+    * //element(kite, app:Asset)
 
 ##### Cost Overrides