Author: chetanm
Date: Tue Mar 21 12:25:04 2017
New Revision: 1787951
URL: http://svn.apache.org/viewvc?rev=1787951&view=rev
Log:
OAK-5946 - Document indexing flow
Enumerate the supported index type
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/indexing.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/indexing.md
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/indexing.md?rev=1787951&r1=1787950&r2=1787951&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/indexing.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/indexing.md Tue Mar 21
12:25:04 2017
@@ -71,8 +71,13 @@ Index definitions are nodes of type `oak
As part of diff traversal at each level `IndexUpdate` would look for
`oak:index` nodes. The index definitions nodes have
following properties
-1. `type` - It determines the _type_ of index. For e.g. it can be `property`,
`lucene`, `solr` etc. Based on the `type`
- `IndexUpdate` would look for `IndexEditor` of given type from registered
`IndexEditorProvider`
+1. `type` - It determines the _type_ of index. Based on the `type`
`IndexUpdate` would look for `IndexEditor` of given
+ type from registered `IndexEditorProvider`. For out of the box Oak setup
it can have one of the following value
+ * `reference` - Configured with out of box setup
+ * `counter` - Configured with out of box setup
+ * `property`
+ * `lucene`
+ * `solr`
2. `async` - It determines if the index is to be updated synchronously or
asynchronously. It can have following values
* `sync` - Also the default value. It indicates that index is meant to be
updated as part of commit
* `nrt` - Indicates that index is a [near real time](#nrt-indexing)
index.
