jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From thom...@apache.org
Subject svn commit: r1853120 - in /jackrabbit/site/live/oak/docs: nodestore/document/metrics.html query/lucene.html release-schedule.html
Date Thu, 07 Feb 2019 11:18:45 GMT
Author: thomasm
Date: Thu Feb  7 11:18:44 2019
New Revision: 1853120

URL: http://svn.apache.org/viewvc?rev=1853120&view=rev
Log:
OAK-936: Site checkin for project Oak Documentation-1.12-SNAPSHOT

Modified:
    jackrabbit/site/live/oak/docs/nodestore/document/metrics.html
    jackrabbit/site/live/oak/docs/query/lucene.html
    jackrabbit/site/live/oak/docs/release-schedule.html

Modified: jackrabbit/site/live/oak/docs/nodestore/document/metrics.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/metrics.html?rev=1853120&r1=1853119&r2=1853120&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/metrics.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/metrics.html Thu Feb  7 11:18:44 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-01-08 
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-02-07 
  | Rendered using Apache Maven Fluido Skin 1.6
 -->
 <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="20190108" />
+    <meta name="Date-Revision-yyyymmdd" content="20190207" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak &#x2013; Metrics</title>
     <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -142,9 +142,9 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-08<span class="divider">|</span>
+        <li id="publishDate">Last Published: 2019-02-07<span class="divider">|</span>
 </li>
-          <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
+          <li id="projectVersion">Version: 1.12-SNAPSHOT</li>
         </ul>
       </div>
       <div class="row-fluid">
@@ -521,11 +521,26 @@
 <tr class="b">
 <td>DOCUMENT_NS_MERGE_SUCCESS_TIME </td>
 <td> The time it takes a successful merge to complete. This does not include merge
attempts that failed.</td></tr>
+<tr class="a">
+<td>DOCUMENT_NS_HEAD_OF_QUEUE_WAIT_TIME </td>
+<td> The time a merge had to wait in the commit queue until it was the head of the
queue and could proceed.</td></tr>
+<tr class="b">
+<td>DOCUMENT_NS_MERGE_SUSPEND_TIME </td>
+<td> The time a merge was suspended due to a conflicting write on another cluster node.</td></tr>
+<tr class="a">
+<td>DOCUMENT_NS_MERGE_LOCK_TIME </td>
+<td> The time it took to acquire the merge lock.</td></tr>
+<tr class="b">
+<td>DOCUMENT_NS_MERGE_COMMIT_HOOK_TIME </td>
+<td> The time it took to run the commit hook on the changes to merge.</td></tr>
+<tr class="a">
+<td>DOCUMENT_NS_MERGE_CHANGES_APPLIED_TIME </td>
+<td> The time it took to apply the changes to the DocumentStore.</td></tr>
 </tbody>
 </table>
 <blockquote>
 
-<p>Note: Oak tracks the duration for above timers at millisecond accuracy, but tools
may translate the duration percentiles to different units.</p>
+<p>Note: Oak tracks the duration for above timers at millisecond or microsecond accuracy,
but tools may translate the duration percentiles to different units.</p>
 </blockquote>
 <p>If a <tt>DocumentNodeStore</tt> is configured with persistent caches,
then the following Meters are available:</p>
 <table border="0" class="table table-striped">

Modified: jackrabbit/site/live/oak/docs/query/lucene.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/lucene.html?rev=1853120&r1=1853119&r2=1853120&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/lucene.html (original)
+++ jackrabbit/site/live/oak/docs/query/lucene.html Thu Feb  7 11:18:44 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-01-08 
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-02-07 
  | Rendered using Apache Maven Fluido Skin 1.6
 -->
 <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="20190108" />
+    <meta name="Date-Revision-yyyymmdd" content="20190207" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak &#x2013; Lucene Index</title>
     <link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -142,9 +142,9 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-08<span class="divider">|</span>
+        <li id="publishDate">Last Published: 2019-02-07<span class="divider">|</span>
 </li>
-          <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
+          <li id="projectVersion">Version: 1.12-SNAPSHOT</li>
         </ul>
       </div>
       <div class="row-fluid">
@@ -295,7 +295,9 @@
 </ul>
 </li>
 <li><a href="#non-root-index">Non Root Index Definitions</a></li>
+<li><a href="#function-based-indexing">Function-Based Indexing</a></li>
 <li><a href="#native-query">Native Query and Index Selection</a></li>
+<li><a href="#persisting-indexes">Persisting indexes</a></li>
 <li><a href="#copy-on-read">CopyOnRead</a></li>
 <li><a href="#copy-on-write">CopyOnWrite</a></li>
 <li><a href="#mbeans">Lucene Index MBeans</a></li>
@@ -659,7 +661,10 @@
 
 <dt>excludeFromAggregation</dt>
 <dd>Since 1.0.27, 1.2.11</dd>
-<dd>if set to true the property would be excluded from aggregation <a class="externalLink"
href="https://issues.apache.org/jira/browse/OAK-3981">OAK-3981</a></dd>
+<dd>If set to true, the property is excluded from aggregation <a class="externalLink"
href="https://issues.apache.org/jira/browse/OAK-3981">OAK-3981</a></dd>
+<dt>function</dt>
+<dd>Since 1.5.11, 1.6.0</dd>
+<dd>Function, for <a href="#function-based-indexing">function-based indexing</a>.</dd>
 <dt><a name="weight"></a></dt>
 <dt>weight</dt>
 <dd>Allows to override the estimated number of entries per value, which affects the
cost of the index.</dd>
@@ -1169,6 +1174,36 @@ WHERE
 
 <p>Then you can create the required index definition say <tt>assetIndex</tt>
at <tt>/content/companya/oak:index/assetIndex</tt>. In such a case that index
would contain data for the subtree under <tt>/content/companya</tt></p></div>
 <div class="section">
+<h3><a name="Function-Based_Indexing"></a><a name="function-based-indexing"></a>Function-Based
Indexing</h3>
+<p><tt>@since Oak 1.5.11, 1.6.0</tt></p>
+<p>Function-based indexes can for example allow to search (or order by) the lower case
version of a property. For more details see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-3574">OAK-3574</a>.</p>
+<p>For example using the index definition</p>
+
+<div>
+<div>
+<pre class="source">uppercaseLastName
+  - function = &quot;fn:upper-case(@lastName)&quot;
+  - propertyIndex = true
+  - ordered = true
+</pre></div></div>
+
+<p>This allows to search for, and order by, the lower case version of the property
&#x201c;lastName&#x201d;. Example functions:</p>
+<ul>
+
+<li>fn:upper-case(@data)</li>
+<li>fn:lower-case(test/@data)</li>
+<li>fn:lower-case(fn:name())</li>
+<li>fn:lower-case(fn:local-name())</li>
+<li>fn:string-length(test/@data)</li>
+<li>upper([data])</li>
+<li>lower([test/data])</li>
+<li>lower(name())</li>
+<li>lower(localname())</li>
+<li>length([test/data])</li>
+<li>length(name())</li>
+</ul>
+<p>Indexing multi-valued properties is supported. Relative properties are supported
(except for &#x201c;..&#x201d; and &#x201c;.&#x201d;). Range conditions are
supported (&#x2018;&gt;&#x2019;, &#x2018;&gt;=&#x2019;, &#x2018;&lt;=&#x2019;,
&#x2018;&lt;&#x2019;).</p></div>
+<div class="section">
 <h3><a name="Native_Query_and_Index_Selection"></a><a name="native-query"></a>Native
Query and Index Selection</h3>
 <p>Oak query engine supports native queries like</p>
 
@@ -1179,16 +1214,16 @@ WHERE
 
 <p>If multiple Lucene based indexes are enabled on the system and you need to make
use of specific Lucene index like <tt>/oak:index/assetIndex</tt> then you can
specify the index name via <tt>functionName</tt> attribute on index definition.</p>
 <p>For example for assetIndex definition like</p>
-<ul>
 
-<li>jcr:primaryType = &#x201c;oak:QueryIndexDefinition&#x201d;
-<ul>
+<div>
+<div>
+<pre class="source">luceneAssetIndex
+  - jcr:primaryType = &quot;oak:QueryIndexDefinition&quot;
+  - type = &quot;lucene&quot;
+  ...
+  - functionName = &quot;lucene-assetIndex&quot;
+</pre></div></div>
 
-<li>type = &#x201c;lucene&#x201d; &#x2026;</li>
-<li>functionName = &#x201c;lucene-assetIndex&#x201d;</li>
-</ul>
-</li>
-</ul>
 <p>Executing following query would ensure that Lucene index from <tt>assetIndex</tt>
should be used</p>
 
 <div>
@@ -1197,7 +1232,7 @@ WHERE
 </pre></div></div>
 </div>
 <div class="section">
-<h3><a name="Persisting_indexes_to_FileSystem"></a><a name="native-query"></a>Persisting
indexes to FileSystem</h3>
+<h3><a name="Persisting_indexes_to_FileSystem"></a><a name="persisting-indexes"></a>Persisting
indexes to FileSystem</h3>
 <p>By default Lucene indexes are stored in the <tt>NodeStore</tt>. If required
they can be stored on the file system directly</p>
 <ul>
 

Modified: jackrabbit/site/live/oak/docs/release-schedule.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/release-schedule.html?rev=1853120&r1=1853119&r2=1853120&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/release-schedule.html (original)
+++ jackrabbit/site/live/oak/docs/release-schedule.html Thu Feb  7 11:18:44 2019
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-01-08 
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-02-07 
  | Rendered using Apache Maven Fluido Skin 1.6
 -->
 <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="20190108" />
+    <meta name="Date-Revision-yyyymmdd" content="20190207" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak &#x2013; Release Schedule</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -142,9 +142,9 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2019-01-08<span class="divider">|</span>
+        <li id="publishDate">Last Published: 2019-02-07<span class="divider">|</span>
 </li>
-          <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
+          <li id="projectVersion">Version: 1.12-SNAPSHOT</li>
         </ul>
       </div>
       <div class="row-fluid">
@@ -257,12 +257,13 @@
 <p>Here is the frequency where the team <b>aim</b> to cut new releases.
As we strive for quality rather than frequency the date may slip according to needs.</p>
 <ul>
 
-<li>Trunk: every 2 weeks (2 / month, ~26 /year)</li>
-<li>1.8: every 4 weeks (1 / month, ~12 / year)</li>
-<li>1.6: every 8 weeks (1 / other month, ~6 / year)</li>
-<li>1.4: every 13 weeks (1 / quarter, ~4 / year)</li>
-<li>1.2: every 13 weeks (1 / quarter, ~4 / year)</li>
-<li>1.0: every 26 weeks (~2 / year)</li>
+<li>Trunk: TBD</li>
+<li>1.10: every 4 weeks (~12 / year)</li>
+<li>1.8: every 8 weeks (~6 / year)</li>
+<li>1.6: every 13 weeks (~4 / year)</li>
+<li>1.4: every 26 weeks (~2 / year)</li>
+<li>1.2: every 52 weeks (1 / year)</li>
+<li>1.0: every 52 weeks (1 / year)</li>
 </ul>
         </div>
       </div>



Mime
View raw message