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 2019/05/17 12:31:03 UTC
svn commit: r1859431 - in /jackrabbit/site/live/oak/docs:
nodestore/document/mongo-document-store.html oakathons.html
query/query-engine.html
Author: thomasm
Date: Fri May 17 12:31:03 2019
New Revision: 1859431
URL: http://svn.apache.org/viewvc?rev=1859431&view=rev
Log:
OAK-936: Site checkin for project Oak Documentation-1.14-SNAPSHOT
Added:
jackrabbit/site/live/oak/docs/oakathons.html
Modified:
jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html
jackrabbit/site/live/oak/docs/query/query-engine.html
Modified: jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html?rev=1859431&r1=1859430&r2=1859431&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html (original)
+++ jackrabbit/site/live/oak/docs/nodestore/document/mongo-document-store.html Fri May 17 12:31:03 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-05-17
| 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="20190517" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – MongoDB DocumentStore</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-05-17<span class="divider">|</span>
</li>
- <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
+ <li id="projectVersion">Version: 1.14-SNAPSHOT</li>
</ul>
</div>
<div class="row-fluid">
@@ -170,6 +170,7 @@
<ul class="nav nav-list">
<li class="active"><a href="#"><span class="none"></span>MongoDB DocumentStore</a>
</li>
+ <li><a href="../../nodestore/document/rdb-document-store.html" title="RDB DocumentStore"><span class="none"></span>RDB DocumentStore</a> </li>
<li><a href="../../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="../../nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="../../nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -291,6 +292,9 @@
<tr class="a">
<td>1.8.7 or newer </td>
<td> 3.6.x</td></tr>
+<tr class="b">
+<td>1.10.x or newer </td>
+<td> 4.0.x</td></tr>
</tbody>
</table>
<p>For production deployments use a replica-set with at least three mongod instances and a majority write concern. Fewer than three instances (e.g. two instances and an arbiter) may lead to data loss when the primary fails.</p>
Added: jackrabbit/site/live/oak/docs/oakathons.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/oakathons.html?rev=1859431&view=auto
==============================================================================
--- jackrabbit/site/live/oak/docs/oakathons.html (added)
+++ jackrabbit/site/live/oak/docs/oakathons.html Fri May 17 12:31:03 2019
@@ -0,0 +1,271 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-05-17
+ | 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="20190517" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Jackrabbit Oak – Oakathons</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
+ </head>
+ <body class="topBarEnabled">
+ <a href="https://github.com/apache/jackrabbit-oak">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+<a class="brand" href="./" title="Oak logo"><img src="oak_logo.png" alt="Oak logo" />
+</a>
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="index.html" title="Jackrabbit Oak">Jackrabbit Oak</a></li>
+ <li><a href="license.html" title="License">License</a></li>
+ <li><a href="downloads.html" title="Downloads">Downloads</a></li>
+ <li><a href="articles.html" title="Articles">Articles</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and Architecture <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="architecture/overview.html" title="Overview">Overview</a></li>
+ <li><a href="architecture/nodestate.html" title="The Node State Model">The Node State Model</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a></li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
+ <li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Features and Plugins <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li class="dropdown-submenu">
+<a href="nodestore/overview.html" title="Node Storage">Node Storage</a>
+ <ul class="dropdown-menu">
+ <li><a href="nodestore/documentmk.html" title="Document NodeStore">Document NodeStore</a></li>
+ <li><a href="nodestore/segment/overview.html" title="Segment NodeStore">Segment NodeStore</a></li>
+ <li><a href="nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
+ </ul>
+ </li>
+ <li class="dropdown-submenu">
+<a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
+ <ul class="dropdown-menu">
+ <li><a href="features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
+ </ul>
+ </li>
+ <li class="dropdown-submenu">
+<a href="query/query.html" title="Query">Query</a>
+ <ul class="dropdown-menu">
+ <li><a href="query/query-engine.html" title="Query Engine">Query Engine</a></li>
+ <li><a href="query/grammar-xpath.html" title="XPath Grammar">XPath Grammar</a></li>
+ <li><a href="query/grammar-sql2.html" title="SQL-2 Grammar">SQL-2 Grammar</a></li>
+ <li><a href="query/query-troubleshooting.html" title="Troubleshooting">Troubleshooting</a></li>
+ <li><a href="query/indexing.html" title="Indexing">Indexing</a></li>
+ <li><a href="query/lucene.html" title="Lucene Index">Lucene Index</a></li>
+ <li><a href="query/property-index.html" title="Property Index">Property Index</a></li>
+ <li><a href="query/solr.html" title="Solr Index">Solr Index</a></li>
+ </ul>
+ </li>
+ <li><a href="security/overview.html" title="Security">Security</a></li>
+ <li><a href="features/atomic-counter.html" title="Atomic Counter">Atomic Counter</a></li>
+ <li><a href="features/observation.html" title="Observation">Observation</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="use_getting_started.html" title="Getting Started">Getting Started</a></li>
+ <li><a href="construct.html" title="Repository Construction">Repository Construction</a></li>
+ <li><a href="osgi_config.html" title="Configuring Oak">Configuring Oak</a></li>
+ <li><a href="command_line.html" title="Command Line Tools">Command Line Tools</a></li>
+ <li><a href="migration.html" title="Migration">Migration</a></li>
+ <li><a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a></li>
+ <li><a href="known_issues.html" title="Known Issues">Known Issues</a></li>
+ <li><a href="constraints.html" title="Constraints">Constraints</a></li>
+ <li><a href="dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a></li>
+ <li><a href="coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a></li>
+ <li><a href="FAQ.html" title="FAQ">FAQ</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="dev_getting_started.html" title="Getting Started">Getting Started</a></li>
+ <li><a href="participating.html" title="Participating">Participating</a></li>
+ <li><a href="developing-with-git.html" title="Developing with Git">Developing with Git</a></li>
+ <li><a href="diagnostic-builds.html" title="Cutting diagnostic builds">Cutting diagnostic builds</a></li>
+ <li><a href="branching.html" title="Branching off a new stable">Branching off a new stable</a></li>
+ <li><a href="attribution.html" title="Attribution">Attribution</a></li>
+ <li><a href="release-schedule.html" title="Release Schedule">Release Schedule</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://jackrabbit.apache.org/oak" title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a></li>
+ <li><a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left"><div id="bannerLeft"><h2>Oak Documentation</h2>
+</div>
+</div>
+ <div class="pull-right"></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li id="publishDate">Last Published: 2019-05-17<span class="divider">|</span>
+</li>
+ <li id="projectVersion">Version: 1.14-SNAPSHOT</li>
+ </ul>
+ </div>
+ <div class="row-fluid">
+ <div id="leftColumn" class="span2">
+ <div class="well sidebar-nav">
+<ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+ <li><a href="index.html" title="Jackrabbit Oak"><span class="none"></span>Jackrabbit Oak</a> </li>
+ <li><a href="license.html" title="License"><span class="none"></span>License</a> </li>
+ <li><a href="downloads.html" title="Downloads"><span class="none"></span>Downloads</a> </li>
+ <li><a href="articles.html" title="Articles"><span class="none"></span>Articles</a> </li>
+ <li class="nav-header">Concepts and Architecture</li>
+ <li><a href="architecture/overview.html" title="Overview"><span class="none"></span>Overview</a> </li>
+ <li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>The Node State Model</a> </li>
+ <li class="nav-header">Main APIs</li>
+ <li><a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API"><span class="none"></span>JCR API</a> </li>
+ <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
+ <li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
+ <li class="nav-header">Features and Plugins</li>
+ <li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
+ <ul class="nav nav-list">
+ <li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
+ <ul class="nav nav-list">
+ <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
+ <li><a href="nodestore/document/rdb-document-store.html" title="RDB DocumentStore"><span class="none"></span>RDB DocumentStore</a> </li>
+ <li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
+ <li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
+ <li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
+ <li><a href="clustering.html" title="Clustering"><span class="none"></span>Clustering</a> </li>
+ </ul>
+ </li>
+ <li><a href="nodestore/segment/overview.html" title="Segment NodeStore"><span class="none"></span>Segment NodeStore</a> </li>
+ <li><a href="nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
+ </ul>
+ </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
+ <ul class="nav nav-list">
+ <li><a href="features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
+ </ul>
+ </li>
+ <li><a href="query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
+ <ul class="nav nav-list">
+ <li><a href="query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
+ <li><a href="query/grammar-xpath.html" title="XPath Grammar"><span class="none"></span>XPath Grammar</a> </li>
+ <li><a href="query/grammar-sql2.html" title="SQL-2 Grammar"><span class="none"></span>SQL-2 Grammar</a> </li>
+ <li><a href="query/query-troubleshooting.html" title="Troubleshooting"><span class="none"></span>Troubleshooting</a> </li>
+ <li><a href="query/indexing.html" title="Indexing"><span class="none"></span>Indexing</a> </li>
+ <li><a href="query/lucene.html" title="Lucene Index"><span class="none"></span>Lucene Index</a> </li>
+ <li><a href="query/property-index.html" title="Property Index"><span class="none"></span>Property Index</a> </li>
+ <li><a href="query/solr.html" title="Solr Index"><span class="none"></span>Solr Index</a> </li>
+ </ul>
+ </li>
+ <li><a href="security/overview.html" title="Security"><span class="none"></span>Security</a> </li>
+ <li><a href="features/atomic-counter.html" title="Atomic Counter"><span class="none"></span>Atomic Counter</a> </li>
+ <li><a href="features/observation.html" title="Observation"><span class="none"></span>Observation</a> </li>
+ <li class="nav-header">Using Oak</li>
+ <li><a href="use_getting_started.html" title="Getting Started"><span class="none"></span>Getting Started</a> </li>
+ <li><a href="construct.html" title="Repository Construction"><span class="none"></span>Repository Construction</a> </li>
+ <li><a href="osgi_config.html" title="Configuring Oak"><span class="none"></span>Configuring Oak</a> </li>
+ <li><a href="command_line.html" title="Command Line Tools"><span class="none"></span>Command Line Tools</a> </li>
+ <li><a href="migration.html" title="Migration"><span class="none"></span>Migration</a> </li>
+ <li><a href="differences.html" title="Differences to Jackrabbit 2"><span class="none"></span>Differences to Jackrabbit 2</a> </li>
+ <li><a href="known_issues.html" title="Known Issues"><span class="none"></span>Known Issues</a> </li>
+ <li><a href="constraints.html" title="Constraints"><span class="none"></span>Constraints</a> </li>
+ <li><a href="dos_and_donts.html" title="Dos and Don'ts"><span class="none"></span>Dos and Don'ts</a> </li>
+ <li><a href="coldstandby/coldstandby.html" title="Cold Standby"><span class="none"></span>Cold Standby</a> </li>
+ <li><a href="FAQ.html" title="FAQ"><span class="none"></span>FAQ</a> </li>
+ <li class="nav-header">Developing Oak</li>
+ <li><a href="dev_getting_started.html" title="Getting Started"><span class="none"></span>Getting Started</a> </li>
+ <li><a href="participating.html" title="Participating"><span class="none"></span>Participating</a> </li>
+ <li><a href="developing-with-git.html" title="Developing with Git"><span class="none"></span>Developing with Git</a> </li>
+ <li><a href="diagnostic-builds.html" title="Cutting diagnostic builds"><span class="none"></span>Cutting diagnostic builds</a> </li>
+ <li><a href="branching.html" title="Branching off a new stable"><span class="none"></span>Branching off a new stable</a> </li>
+ <li><a href="attribution.html" title="Attribution"><span class="none"></span>Attribution</a> </li>
+ <li><a href="release-schedule.html" title="Release Schedule"><span class="none"></span>Release Schedule</a> </li>
+ <li class="nav-header">Links</li>
+ <li><a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak"><span class="none"></span>Apache Jackrabbit Oak</a> </li>
+ <li><a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit"><span class="none"></span>Apache Jackrabbit</a> </li>
+ </ul>
+ <hr />
+ <div id="poweredBy">
+ <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script>
+ <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak/docs/" data-size="tall" ></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+ </div>
+ </div>
+ </div>
+ <div id="bodyColumn" class="span10" >
+<h1>Oakathons</h1>
+<p>The Oak developers hold fairly regular Oak meetups called “Oakathons.” These community-driven meetups are open to anyone working on or with Oak to attend, either in person or remotely via videoconference.</p>
+<p>Oakathons follow loose, community-driven schedules that evolve in real time to address the needs of the group.</p>
+<div class="section">
+<h2><a name="Purpose"></a>Purpose</h2>
+<p>Oakathons serve three primary purposes which all hold equal importance: * To conduct a “state of the project” review, where we can discuss major Oak components and the strategic direction. * To provide time and space for free-form, synchronized discussions on issues important to key project components as well as issues impacting the whole project. * To hack on Oak itself - trying experiments, implementing new features, fixing bugs, or collaborating with others on such efforts.</p>
+<p>Prior to each Oakathon we attempt to identify clear outcomes, both technical accomplishments and discussion results, that we intend to accomplish.</p></div>
+<div class="section">
+<h2><a name="Cadence"></a>Cadence</h2>
+<p>Oakathons take place roughly once every three months - roughly every March, June, September, and December. They are generally held at the Adobe office in Basel, Switzerland unless otherwise specified. Oakathons take place over four days, Monday through Thursday, with Friday being an optional extra day.</p>
+<p>Prior to the beginning of the Oakathon, the initial schedule will be announced on oak-dev@. This usually consists of just the starting time for the first day. The rest of the schedule evolves throughout the week.</p></div>
+<div class="section">
+<h2><a name="Planning"></a>Planning</h2>
+<p>Planning for an Oakathon is as follows: * The PMC determines a specific date for the next Oakathon. This is done usually between six and twelve weeks in advance of the selected date, to allow opportunity for remote attendees who wish to attend to obtain travel budget and make appropriate plans. * An issue is created in the Oak issue tracker to gather input and feedback on proposed discussion topics and projects. * The upcoming Oakathon is announced on the public mailing list (oak-dev@). * Proposals for discussion topics or projects for the Oakathon continue to be collected in the Oakathon issue up until the Oakathon begins - and sometimes even during the Oakathon itself.</p></div>
+ </div>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>Copyright ©2012–2019
+<a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.</p>
+ </div>
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="https://www.ohloh.net/p/jackrabbit-oak/widgets/project_thin_badge.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Modified: jackrabbit/site/live/oak/docs/query/query-engine.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query/query-engine.html?rev=1859431&r1=1859430&r2=1859431&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query/query-engine.html (original)
+++ jackrabbit/site/live/oak/docs/query/query-engine.html Fri May 17 12:31:03 2019
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-01-18
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2019-05-17
| 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="20190118" />
+ <meta name="Date-Revision-yyyymmdd" content="20190517" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – The Query Engine</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-18<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2019-05-17<span class="divider">|</span>
</li>
- <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
+ <li id="projectVersion">Version: 1.14-SNAPSHOT</li>
</ul>
</div>
<div class="row-fluid">
@@ -169,6 +169,7 @@
<li><a href="../nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
<li><a href="../nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
+ <li><a href="../nodestore/document/rdb-document-store.html" title="RDB DocumentStore"><span class="none"></span>RDB DocumentStore</a> </li>
<li><a href="../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="../nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="../nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -301,6 +302,7 @@ grep "^#.*$" src/site/markdown/query/que
<li><a href="#Index_Storage_and_Manual_Inspection">Index Storage and Manual Inspection</a></li>
<li><a href="#SQL-2_Optimisation">SQL-2 Optimisation</a></li>
<li><a href="#Additional_XPath_and_SQL-2_Features">Additional XPath and SQL-2 Features</a></li>
+<li><a href="#Temporarily_Blocking_Queries">Temporarily Blocking Queries</a></li>
</ul>
</li>
</ul></div>
@@ -764,7 +766,36 @@ select * from [nt:base] as a where issam
union select * from [nt:base] as a where issamenode(a, '/lib')
</pre></div></div>
-<p>XPath functions “fn:string-length” and “fn:local-name”.</p></div></div>
+<p>XPath functions “fn:string-length” and “fn:local-name”.</p></div>
+<div class="section">
+<h3><a name="Temporarily_Blocking_Queries"></a>Temporarily Blocking Queries</h3>
+
+<div>
+<div>
+<pre class="source">@since 1.14.0
+</pre></div></div>
+
+<p>Application code can run bad queries that read a lot of data or consume a lot of memory. The best solution is to fix the application, however this can take some time. Queries can be blocked at runtime using validator patterns, without having to immediately change the application. Validator patterns can be set and inspected using the JMX <tt>QueryEngineSettingsMBean</tt> as follows:</p>
+<ul>
+
+<li><tt>setQueryValidatorPattern</tt>: Adds or removes a query pattern.</li>
+<li><tt>queryValidatorJson</tt>: Gets the existing patterns, including how often and when last execution occurred.</li>
+</ul>
+<p>When adding a new pattern, it is recommended to first set <tt>failQuery</tt> to <tt>false</tt> to verify the pattern is correct (only a warning is logged when running matching queries). Once the pattern is correct, set <tt>failQuery</tt> to <tt>true</tt>. Validator patterns can be stored in the repository under <tt>/oak:index/queryValidator/<patternKey></tt> (nodetype e.g. <tt>nt:unstructured</tt>) as follows:</p>
+<ul>
+
+<li><tt>pattern</tt>: The regular expression of the query. Alternatively, a multi-valued string that contains a list of exact parts of the query.</li>
+<li><tt>failQuery</tt>: Whether to fail the query (true) or just log a warning (false).</li>
+<li><tt>comment</tt>: The pattern comment.</li>
+</ul>
+<p>If the pattern is set using the multi-valued string, then the regular expression pattern is constructed from this array of texts. In this case, no escaping is needed. Example patterns are:</p>
+<ul>
+
+<li><tt>[ "SELECT * FROM", "ORDER BY [name]" ]</tt>: All queries that start and end with the given texts.</li>
+<li><tt>"/jcr:root/var/acme/.*"</tt>: All queries that match this regular expression.</li>
+</ul>
+<p>Patterns are evaluated in alphabetical order. They are only read once, at startup.</p>
+<p>See also <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-8294">OAK-8294</a></p></div></div>
</div>
</div>
</div>