You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by th...@apache.org on 2015/02/26 15:20:08 UTC

svn commit: r1662451 - /jackrabbit/site/live/oak/docs/query/query.html

Author: thomasm
Date: Thu Feb 26 14:20:08 2015
New Revision: 1662451

URL: http://svn.apache.org/r1662451
Log:
OAK-936: Site checkin for project Oak Documentation-1.1-SNAPSHOT

Modified:
    jackrabbit/site/live/oak/docs/query/query.html

Modified: jackrabbit/site/live/oak/docs/query/query.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/query.html?rev=1662451&r1=1662450&r2=1662451&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/query.html (original)
+++ jackrabbit/site/live/oak/docs/query/query.html Thu Feb 26 14:20:08 2015
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2015-02-25
+ | Generated by Apache Maven Doxia at 2015-02-26
  | Rendered using Apache Maven Fluido Skin 1.3.0
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20150225" />
+    <meta name="Date-Revision-yyyymmdd" content="20150226" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak - The Query Engine</title>
     <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -192,7 +192,7 @@
         <ul class="breadcrumb">
                 
                     
-                  <li id="publishDate">Last Published: 2015-02-25</li>
+                  <li id="publishDate">Last Published: 2015-02-26</li>
                   <li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
                       
                 
@@ -572,8 +572,9 @@ org.apache.jackrabbit.oak.query.QueryEng
   
 <li>must have the <tt>type</tt> property set to <b><tt>property</tt></b></li>
   
-<li>contains the <tt>propertyNames</tt> property that indicates what properties will be stored in the index.  <tt>propertyNames</tt> can be a list of properties, and it is optional.in case it is missing, the node name will be used as a property name reference value</li>
+<li>contains the <tt>propertyNames</tt> property. 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.</li>
 </ul>
+<p>It is recommended to index one property per index. (If multiple properties are indexed within one index, then the index contains all nodes that has either one of the properties, which can make the query less efficient, and can make the query pick the wrong index.)</p>
 <p><i>Optionally</i> you can specify</p>
 
 <ul>
@@ -610,8 +611,6 @@ org.apache.jackrabbit.oak.query.QueryEng
   IndexUtils.createIndexDefinition(index, &quot;myProp&quot;, true, false, ImmutableList.of(&quot;myProp&quot;), null);
 }
 </pre></div>
-<p>(Not sure if this is correct) <b>Note on <tt>propertyNames</tt></b> Adding a property index definition that contains two or more properties will only include nodes that have <i>all</i> specified properties present. This is different than adding a dedicated property index for each and letting the query engine make use of them.</p>
-<p>(Not sure if this is correct) <b>Note</b> Is is currently not possible to add more than one property index on the same property name, even if it might be used in various combinations with other property names. This rule is not enforced in any way, but the behavior is undefined, one of the defined indexes will be updated while the others will simply be ignored by the indexer which can result in empty result sets at query time.</p>
 <div class="section">
 <h4>Reindexing<a name="Reindexing"></a></h4>
 <p>Reindexing a property index happens synchronously by setting the <b><tt>reindex</tt></b> flag to <b><tt>true</tt></b>. This means that the first #save call will generate a full repository traversal with the purpose of building the index content and it might take a long time.</p>