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/04/24 11:45:49 UTC
svn commit: r1675809 - /jackrabbit/site/live/oak/docs/query/query.html
Author: thomasm
Date: Fri Apr 24 09:45:48 2015
New Revision: 1675809
URL: http://svn.apache.org/r1675809
Log:
OAK-936: Site checkin for project Oak Documentation-1.4-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=1675809&r1=1675808&r2=1675809&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/query.html (original)
+++ jackrabbit/site/live/oak/docs/query/query.html Fri Apr 24 09:45:48 2015
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2015-04-16
+ | Generated by Apache Maven Doxia at 2015-04-24
| 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="20150416" />
+ <meta name="Date-Revision-yyyymmdd" content="20150424" />
<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" />
@@ -195,7 +195,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2015-04-16</li>
+ <li id="publishDate">Last Published: 2015-04-24</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.4-SNAPSHOT</li>
@@ -582,24 +582,24 @@ org.apache.jackrabbit.oak.query.QueryEng
<li>must be of type <tt>oak:QueryIndexDefinition</tt></li>
-<li>must have the <tt>type</tt> property set to <b><tt>property</tt></b></li>
+<li><tt>type</tt> (String) must have the property set to “property”.</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>
+<li><tt>propertyNames</tt> (Name, multi-valued): the property to be indexed. This is a multi-valued property, and must not be empty. It usually contains only <i>one</i> property name. All nodes that have <i>any</i> 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>
+<p>Optionally you can specify:</p>
<ul>
-<li>a uniqueness constraint on a property index by setting the <tt>unique</tt> flag to <tt>true</tt>,</li>
+<li><tt>declaringNodeTypes</tt> (Name, multi-valued): the index only applies to a certain node type.</li>
-<li>that the property index only applies to a certain node type by setting the <tt>declaringNodeTypes</tt> property,</li>
+<li><tt>unique</tt> (Boolean): if set to <tt>true</tt>, a uniqueness constraint on this property is added. Ensure you set declaringNodeTypes, otherwise all nodes of the repository are affected (which is most likely not what you want), and you are not able to version the node.</li>
-<li>the <tt>entryCount</tt> (a long), the estimated number of path entries in the index, which is used for the cost estimation (a high entry count means a high cost)</li>
+<li><tt>entryCount</tt> (Long): the estimated number of path entries in the index, to override the cost estimation (a high entry count means a high cost).</li>
-<li>the <tt>keyCount</tt> (a long), the estimated number of keys in the index, which is used for the cost estimation (a high key count means a lower cost, when searching for specific keys; has no effect when searching for “is not null”),</li>
+<li><tt>keyCount</tt> (Long), the estimated number of keys in the index, to override the cost estimation (a high key count means a lower cost, when searching for specific keys; has no effect when searching for “is not null”).</li>
-<li>the <tt>reindex</tt> flag which when set to <tt>true</tt>, triggers a full content re-index.</li>
+<li><tt>reindex</tt> (Boolean): if set to <tt>true</tt>, the full content is re-indexed. This can take a long time, and is run synchronously with storing the index (except with an async index). See “Reindexing” below for details.</li>
</ul>
<p>Example:</p>