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 @@ - + Jackrabbit Oak – Metrics @@ -142,9 +142,9 @@
@@ -521,11 +521,26 @@ DOCUMENT_NS_MERGE_SUCCESS_TIME The time it takes a successful merge to complete. This does not include merge attempts that failed. + +DOCUMENT_NS_HEAD_OF_QUEUE_WAIT_TIME + The time a merge had to wait in the commit queue until it was the head of the queue and could proceed. + +DOCUMENT_NS_MERGE_SUSPEND_TIME + The time a merge was suspended due to a conflicting write on another cluster node. + +DOCUMENT_NS_MERGE_LOCK_TIME + The time it took to acquire the merge lock. + +DOCUMENT_NS_MERGE_COMMIT_HOOK_TIME + The time it took to run the commit hook on the changes to merge. + +DOCUMENT_NS_MERGE_CHANGES_APPLIED_TIME + The time it took to apply the changes to the DocumentStore.
-

Note: Oak tracks the duration for above timers at millisecond accuracy, but tools may translate the duration percentiles to different units.

+

Note: Oak tracks the duration for above timers at millisecond or microsecond accuracy, but tools may translate the duration percentiles to different units.

If a DocumentNodeStore is configured with persistent caches, then the following Meters are available:

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 @@ - + Jackrabbit Oak – Lucene Index @@ -142,9 +142,9 @@
@@ -295,7 +295,9 @@
  • Non Root Index Definitions
  • +
  • Function-Based Indexing
  • Native Query and Index Selection
  • +
  • Persisting indexes
  • CopyOnRead
  • CopyOnWrite
  • Lucene Index MBeans
  • @@ -659,7 +661,10 @@
    excludeFromAggregation
    Since 1.0.27, 1.2.11
    -
    if set to true the property would be excluded from aggregation OAK-3981
    +
    If set to true, the property is excluded from aggregation OAK-3981
    +
    function
    +
    Since 1.5.11, 1.6.0
    +
    Function, for function-based indexing.
    weight
    Allows to override the estimated number of entries per value, which affects the cost of the index.
    @@ -1169,6 +1174,36 @@ WHERE

    Then you can create the required index definition say assetIndex at /content/companya/oak:index/assetIndex. In such a case that index would contain data for the subtree under /content/companya

    +

    Function-Based Indexing

    +

    @since Oak 1.5.11, 1.6.0

    +

    Function-based indexes can for example allow to search (or order by) the lower case version of a property. For more details see OAK-3574.

    +

    For example using the index definition

    + +
    +
    +
    uppercaseLastName
    +  - function = "fn:upper-case(@lastName)"
    +  - propertyIndex = true
    +  - ordered = true
    +
    + +

    This allows to search for, and order by, the lower case version of the property “lastName”. Example functions:

    + +

    Indexing multi-valued properties is supported. Relative properties are supported (except for “..” and “.”). Range conditions are supported (‘>’, ‘>=’, ‘<=’, ‘<’).

    +

    Native Query and Index Selection

    Oak query engine supports native queries like

    @@ -1179,16 +1214,16 @@ WHERE

    If multiple Lucene based indexes are enabled on the system and you need to make use of specific Lucene index like /oak:index/assetIndex then you can specify the index name via functionName attribute on index definition.

    For example for assetIndex definition like

    -

    Executing following query would ensure that Lucene index from assetIndex should be used

    @@ -1197,7 +1232,7 @@ WHERE
    -

    Persisting indexes to FileSystem

    +

    Persisting indexes to FileSystem

    By default Lucene indexes are stored in the NodeStore. If required they can be stored on the file system directly