Skip to content
Browse files
OAK-9699 Document Elastic Indexes
  • Loading branch information
thomasmueller committed Feb 18, 2022
1 parent 4b285d2 commit 748b8d817442da6531fee18c2aa8036fce45e5af
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
@@ -0,0 +1,47 @@
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

## Elastic Index

Oak supports Elasticsearch (Elastic for short) based indexes to support
both property constraint and full text constraints.
Elastic indexes support similar features than [Lucene][lucene] indexes,
however there are differences:

* The `type` is `elastic`.
* The index definition needs to be under `/oak:index`.
Other locations are not supported.
* The `async` property needs to be set to `async`.
Synchronous, `nrt` or other lanes are not supported.
Indexes are updated asynchronously.
* `refresh` is ignored.
Changes take effect immediately after changing them.
Existing documents in Elasticsearch are not changed.
* `reindex` is ignored.
Indexes are automatically built when needed.
We recommend to build then using the `oak-run` tool.
* `codec` is ignored.
* `compatVersion` is ignored.
* `useIfExists` is ignored.
* `blobSize` is ignored.
* `functionName` is ignored.
* `name` is ignored.
* `indexPath` is ignored.
* `analyzers` is ignored.
* For property definitions, `sync` and `unique` are ignored.

@@ -31,13 +31,14 @@ but probably be very slow.

### Indexes

There are 3 main types of indexes available in Oak. For other type
There are 4 main types of indexes available in Oak. For other type
(eg: nodetype) please refer to the [query engine](./query-engine.html)
documentation page.

* [Lucene](./lucene.html)
* [Solr](./solr.html)
* [Elastic](./elastic.html)
* [Property](./property-index.html)
* [Solr](./solr.html)

For more details on how indexing works (for all index types):

0 comments on commit 748b8d8

Please sign in to comment.