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 2018/03/27 09:59:45 UTC
svn commit: r1827823 - in /jackrabbit/site/live/oak/docs: nodestore/
nodestore/segment/ oak-mongo-js/ oak_api/ query/ security/authorization/
Author: thomasm
Date: Tue Mar 27 09:59:45 2018
New Revision: 1827823
URL: http://svn.apache.org/viewvc?rev=1827823&view=rev
Log:
OAK-936: Site checkin for project Oak Documentation-1.10-SNAPSHOT
Modified:
jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html
jackrabbit/site/live/oak/docs/nodestore/segment/classes.html
jackrabbit/site/live/oak/docs/nodestore/segment/classes.png
jackrabbit/site/live/oak/docs/oak-mongo-js/index.html
jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html
jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html
jackrabbit/site/live/oak/docs/oak_api/overview.html
jackrabbit/site/live/oak/docs/query/index-management.html
jackrabbit/site/live/oak/docs/query/lucene.html
jackrabbit/site/live/oak/docs/security/authorization/cug.html
Modified: jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/persistent-cache.html Tue Mar 27 09:59:45 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-03-27
| 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="20180221" />
+ <meta name="Date-Revision-yyyymmdd" content="20180327" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Persistent Cache</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-03-27<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -249,7 +249,7 @@
<div class="source">
<div class="source"><pre class="prettyprint">org.apache.jackrabbit.oak.plugins.document.DocumentNodeStoreService
- persistentCache="cache,binary\=0"
+ persistentCache="cache"
</pre></div></div>
<p>Oak version up to 1.4 have the persistent cache disabled by default, which is equivalent with a configuration entry set to an empty String. Starting with Oak 1.6, the persistent cache is enabled by default and can be disabled by setting the configuration entry to <tt>"-"</tt>.</p></div>
<div class="section">
@@ -268,9 +268,6 @@
<p>Size. A file is at most 1 GB by default. To change maximum size of a file, use “size=x”, where x is the size in MB.</p></li>
<li>
-<p>Binary caching. When using the BlobStore, binaries smaller than 1 MB are stored in the persistent cache by default. The maximum size can be changed using the setting “binary=x”, where x is the size in bytes. To disable the binary cache, use “binary=0”.</p></li>
-
-<li>
<p>Node caching. By default, nodes at all revisions are cached. To disable this option, use “-nodes”.</p></li>
<li>
@@ -284,11 +281,14 @@
<li>
<p>Compression. By default, the cache is compressed, saving space. To disable this option, use “-compress”.</p></li>
+
+<li>
+<p>Binary caching (removed in Oak 1.10). When using the BlobStore, binaries smaller than 1 MB are stored in the persistent cache by default. The maximum size can be changed using the setting “binary=x”, where x is the size in bytes. To disable the binary cache, use “binary=0”.</p></li>
</ul>
<p>Those setting can be appended to the persistent cache configuration string. An example configuration is:</p>
<div class="source">
-<div class="source"><pre class="prettyprint">"cache,size\=2048,binary\=0,-compact,-compress"
+<div class="source"><pre class="prettyprint">"cache,size\=2048,-compact,-compress"
</pre></div></div>
<p>To disable the persistent cache entirely in Oak 1.6 and newer, use the following configuration:</p>
Modified: jackrabbit/site/live/oak/docs/nodestore/segment/classes.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segment/classes.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/segment/classes.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/segment/classes.html Tue Mar 27 09:59:45 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-03-27
| 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="20180221" />
+ <meta name="Date-Revision-yyyymmdd" content="20180327" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Design of Oak Segment Tar</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-03-27<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -246,7 +246,8 @@
<p><img src="classes.png" alt="Class diagram" /></p>
<p>The <tt>SegmentNodeStore</tt> is Oak Segment Tar’s implementation of the <a href="../overview.html">NodeStore API</a>. It uses a <tt>Revisions</tt> instance for accessing and setting the current head state, a <tt>SegmentReader</tt> for reading records from segments, a <tt>SegmentWriter</tt> for writing records to segments and a <tt>BlobStore</tt> for reading and writing binaries. </p>
<p>The <tt>SegmentStore</tt> serves as a persistence backend for the <tt>SegmentNodeStore</tt>. It is responsible for providing concrete implementations of <tt>Revisions</tt>, <tt>SegmentReader</tt> and <tt>BlobStore</tt> to the former. </p>
-<p>The <tt>FileStore</tt> is the implementation the <tt>SegmentStore</tt> that persists segments in tar files. The <tt>MemoryStore</tt> (not shown above) is an alternative implementation, which stores the segments in memory only. It is used for testing. </p></div>
+<p>The <tt>FileStore</tt> is the implementation the <tt>SegmentStore</tt> that persists segments in tar files. The <tt>MemoryStore</tt> (not shown above) is an alternative implementation, which stores the segments in memory only. It is used for testing.</p>
+<p>The <tt>FileStore</tt> depends on <tt>TarFiles</tt> for the management of the TAR files on the file system. <tt>TarFiles</tt> is an aggregation of one <tt>TarWriter</tt> and zero or more <tt>TarReader</tt>. This design represents the foundation of the append-only store implemented by the <tt>FileStore</tt>, where data is appended to one <tt>TarWriter</tt> and archived in many <tt>TarReader</tt> over time. </p></div>
</div>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/nodestore/segment/classes.png
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/segment/classes.png?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
Binary files - no diff available.
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/index.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/index.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/index.html Tue Mar 27 09:59:45 2018
@@ -56,7 +56,7 @@
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Feb 23 2018 12:29:55 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Mar 27 2018 11:58:10 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak-mongo.js.html Tue Mar 27 09:59:45 2018
@@ -1105,7 +1105,7 @@ var oak = (function(global){
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Feb 23 2018 12:29:55 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Mar 27 2018 11:58:10 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html (original)
+++ jackrabbit/site/live/oak/docs/oak-mongo-js/oak.html Tue Mar 27 09:59:45 2018
@@ -4114,7 +4114,7 @@ is inactive.
<br class="clear">
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Fri Feb 23 2018 12:29:55 GMT+0100 (CET)
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a> on Tue Mar 27 2018 11:58:10 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>
Modified: jackrabbit/site/live/oak/docs/oak_api/overview.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oak_api/overview.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/oak_api/overview.html (original)
+++ jackrabbit/site/live/oak/docs/oak_api/overview.html Tue Mar 27 09:59:45 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-03-27
| 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="20180221" />
+ <meta name="Date-Revision-yyyymmdd" content="20180327" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak API</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-03-27<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -297,8 +297,6 @@
<li><a href="/oak/docs/apidocs/org/apache/jackrabbit/oak/api/Tree.html">Tree</a></li>
-<li><a href="/oak/docs/apidocs/org/apache/jackrabbit/oak/api/NodeState.html">NodeState</a></li>
-
<li><a href="/oak/docs/apidocs/org/apache/jackrabbit/oak/api/PropertyState.html">PropertyState</a></li>
</ul>
<div class="section">
Modified: jackrabbit/site/live/oak/docs/query/index-management.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/index-management.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/index-management.html (original)
+++ jackrabbit/site/live/oak/docs/query/index-management.html Tue Mar 27 09:59:45 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-03-27
| 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="20180221" />
+ <meta name="Date-Revision-yyyymmdd" content="20180327" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Index Management</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-03-27<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -249,7 +249,13 @@
<div class="source">
<div class="source"><pre class="prettyprint">java -jar oak-run-*.jar json-index --disableBranches --script - \
- mongodb://localhost:27017/oak
+ mongodb://localhost:27017/oak --user admin --password admin
+</pre></div></div>
+<p>When using the segment store, use: </p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-run-*.jar json-index --disableBranches --script - \
+ repository/segmentstore --read-write --user admin --password admin
</pre></div></div>
<p>This will open the repository and allow to write and read from the repository. An example script creates an index “test”, and then re-indexes it:</p>
@@ -356,7 +362,7 @@ exit
exit
</pre></div></div></div>
<div class="section">
-<h4><a name="Create_Nodex_for_Testing"></a>Create Nodex for Testing</h4>
+<h4><a name="Create_Nodes_for_Testing"></a>Create Nodes for Testing</h4>
<p>The tool can also be used for testing queries, and creating nodes. The following creates 1000 nodes <tt>/test/n<x></tt>, saving every 100 nodes:</p>
<div class="source">
@@ -381,7 +387,16 @@ exit
{"session": "save"}
{"print": "done"}
exit
-</pre></div></div></div></div></div>
+</pre></div></div></div>
+<div class="section">
+<h4><a name="Estimate_the_Number_of_Nodes"></a>Estimate the Number of Nodes</h4>
+<p>The following will estimate the number of nodes in a given subtree.</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">{"xpath": "explain measure /jcr:root/content//* option(traversal ok)"}
+exit
+</pre></div></div>
+<p>The field “cost” will contain the number of estimated nodes.</p></div></div></div>
</div>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/query/lucene.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/lucene.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/lucene.html (original)
+++ jackrabbit/site/live/oak/docs/query/lucene.html Tue Mar 27 09:59:45 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-03-27
| 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="20180221" />
+ <meta name="Date-Revision-yyyymmdd" content="20180327" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Lucene Index</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-03-27<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -674,11 +674,10 @@
<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>
<dt><a name="weight"></a></dt>
<dt>weight</dt>
-<dd>Since 1.6.3</dd>
-<dd>At times, we have property definitions which are added to support for dense results right out of the index (e.g. <tt>contains(*, 'foo') AND [bar]='baz'</tt>). In such cases, the added property definition “might” not be the best one to answer queries which only have the property restriction (eg only <tt>[bar]='baz'</tt>). This can happen when that index specifies some exclude paths and hence does not index all <tt>bar</tt> properties.</dd>
+<dd>Allows to override the estimated number of entries per value, which affects the cost of the index.</dd>
+<dd>Since 1.6.3: if <tt>weight</tt> is set to <tt>0</tt>, then this property is assumed not to reduce the cost. Queries that contain <i>only</i> this condition should not use that index. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-5899">OAK-5899</a> for details.</dd>
+<dd>Since 1.7.11: if <tt>weight</tt> is set to <tt>10</tt>, then the estimated number of unique entries is 10. This means, the cost is reduced by a factor of about 10, for queries that contain this condition. See [OAK-6735][OAK-6735] for details.</dd>
</dl>
-<p>For such cases set <tt>weight</tt> to <tt>0</tt> for such properties. In such a case IndexPlanner would not use those property definitions to determine if that index can answer the query but it would still use them if some other index entry causes that index to be selected for evaluating such a query.</p>
-<p>Refer <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-5899">OAK-5899</a> for more details</p>
<p><a name="property-names"></a><b>Property Names</b></p>
<p>Property name can be one of following</p>
Modified: jackrabbit/site/live/oak/docs/security/authorization/cug.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/security/authorization/cug.html?rev=1827823&r1=1827822&r2=1827823&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/security/authorization/cug.html (original)
+++ jackrabbit/site/live/oak/docs/security/authorization/cug.html Tue Mar 27 09:59:45 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-03-27
| 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="20180221" />
+ <meta name="Date-Revision-yyyymmdd" content="20180327" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Managing Access with Closed User Groups (CUG)</title>
<link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-03-27<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -502,7 +502,7 @@
</tr>
</tbody>
</table>
-<p><i>Note:</i> this is an optional feature to extend the <a href="/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authorization/cug/CugExclude.Default.html">default</a> exclusion list. Alternatively, it is possible to plug a custom <tt>CugExclude</tt> implementation matching specific needs (see <a href="#pluggability">below</a>).</p>
+<p><i>Note:</i> This implementation extends the <a href="/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/security/authorization/cug/CugExclude.Default.html">default</a> exclusion list. Alternatively, it is possible to plug a custom <tt>CugExclude</tt> implementation matching specific needs (see <a href="#pluggability">below</a>).</p>
<p><a name="pluggability"></a></p></div></div>
<div class="section">
<h3><a name="Pluggability"></a>Pluggability</h3>
@@ -559,6 +559,8 @@
<li>make your implementation an OSGi service</li>
<li>deploy the bundle containing your implementation in the OSGi container and activate the service.</li>
+
+<li>make sure the default CUGExclude service is properly replaced by the custom implementation.</li>
</ol>
<div class="section">
<div class="section">