You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by da...@apache.org on 2016/02/01 13:15:36 UTC
svn commit: r1727927 - in
/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query: flags.md
query-engine.md query.md
Author: davide
Date: Mon Feb 1 12:15:36 2016
New Revision: 1727927
URL: http://svn.apache.org/viewvc?rev=1727927&view=rev
Log:
OAK-301 - Document Oak
- new page aimint to list the flags for the query engine
Added:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/flags.md
- copied, changed from r1727923, jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md
Copied: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/flags.md (from r1727923, jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md)
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/flags.md?p2=jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/flags.md&p1=jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md&r1=1727923&r2=1727927&rev=1727927&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/flags.md Mon Feb 1 12:15:36 2016
@@ -15,26 +15,21 @@
limitations under the License.
-->
-## Oak Query
+## Flags
-Oak does not index as much content by default as does Jackrabbit
-2. You need to create custom indexes when necessary, much like in
-traditional RDBMSs. If there is no index for a specific query, then
-the repository will be traversed. That is, the query will still work
-but probably be very slow.
+List of available flags to enable/disable options in the query engine
-[The Query Engine](./query-engine.html)
+#### oak.queryFullTextComparisonWithoutIndex
+`@since 1.2.0`
-### Indexes
+Default is `false`. If provided on the command line like
+`-Doak.queryFullTextComparisonWithoutIndex=true` it will allow the
+query engine to parse full text conditions even if no full-text
+indexes are defined.
-There are 3 main types of indexes available in Oak. For other type
-(eg: nodetype) please refer to the [query engine](./query-engine.html)
-documentation page.
+#### oak.query.sql2optimisation
+`@since 1.3.9, 1.3.11`
-* [Lucene](./lucene.html)
-* [Solr](./solr.html)
-* [Property](./property-index.html)
+It will perform another round of optimisation to the provided
+query. See the [related section in Query Engine](query-engine.html#SQL2_Optimisation) page.
-### Customisations
-
-* [Change Out-Of-The-Box Index Definitions](./ootb-index-change.html)
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md?rev=1727927&r1=1727926&r2=1727927&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query-engine.md Mon Feb 1 12:15:36 2016
@@ -349,7 +349,9 @@ entire Lucene directory to the local fil
@since 1.3.9 with -Doak.query.sql2optimisation
-if enabled by providing `-Doak.query.sql2optimisation` at start-up, it
-will perform a round of optimisation on the `Query` object obtained
-after parsing a SQL2 statement. It will for example attempt a
-conversion of OR conditions into UNION (OAK-1617).
\ No newline at end of file
+Enabled by default in 1.3.11 it will perform a round of optimisation
+on the `Query` object obtained after parsing a SQL2 statement. It will
+for example attempt a conversion of OR conditions into UNION
+[OAK-1617](https://issues.apache.org/jira/browse/OAK-1617).
+
+To disable it provide `-Doak.query.sql2optimisation=false` at the start-up.
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md?rev=1727927&r1=1727926&r2=1727927&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/query.md Mon Feb 1 12:15:36 2016
@@ -23,7 +23,8 @@ traditional RDBMSs. If there is no index
the repository will be traversed. That is, the query will still work
but probably be very slow.
-[The Query Engine](./query-engine.html)
+* [The Query Engine](./query-engine.html)
+* [Flags](./flags.html)
### Indexes
@@ -38,3 +39,7 @@ documentation page.
### Customisations
* [Change Out-Of-The-Box Index Definitions](./ootb-index-change.html)
+
+
+
+