chibulcuteanu commented on a change in pull request #497: URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811825877
########## File path: oak-doc/src/site/markdown/query/elastic.md ########## @@ -0,0 +1,48 @@ +<!-- + 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 + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + +## Elastic Index + +Oak supports Elasticsearch (Elastic for short) based indexes for both property constraint and full text constraints. +Elastic indexes support similar features as [Lucene][lucene] indexes, +however there are differences: + +* The `type` is `elasticsearch`. +* The index definition needs to be under `/oak:index`. + Other locations are not supported. +* The `async` property needs to be set to `elastic-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. +* Indexes are NOT automatically built when needed: + They can be build by setting the `reindex` property to `true` or by using the `oak-run` tool. Review comment: typo ```suggestion They can be built by setting the `reindex` property to `true` or by using the `oak-run` tool. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@jackrabbit.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
