You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jackrabbit.apache.org by GitBox <gi...@apache.org> on 2022/02/18 15:21:39 UTC
[GitHub] [jackrabbit-oak] thomasmueller opened a new pull request #497: OAK-9699 Document Elastic Indexes
thomasmueller opened a new pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497
A first step.
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] nit0906 commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
nit0906 commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811115531
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 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`.
Review comment:
The `async` property needs to be set to `async`. --> The `async` property needs to be set to `elastic-async`.
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] nit0906 commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
nit0906 commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811114790
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 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`.
Review comment:
elasticsearch instead of elastic.
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] nit0906 commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
nit0906 commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811114334
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 to support
+both property constraint and full text constraints.
+Elastic indexes support similar features than [Lucene][lucene] indexes,
Review comment:
similar features **than** [Lucene][lucene] --> similar features **as** [Lucene][lucene]
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] chibulcuteanu commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
chibulcuteanu commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811129073
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 to support
+both property constraint and full text constraints.
Review comment:
```suggestion
Oak supports Elasticsearch (Elastic for short) based indexes for both property constraint and full text constraints.
```
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] chibulcuteanu commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
chibulcuteanu commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811133325
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 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.
Review comment:
what do you mean this is ignored? It's the only way to build an ES index after deploying the index definition.
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] chibulcuteanu commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
chibulcuteanu commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811132779
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 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.
Review comment:
```suggestion
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.
We recommend to build them 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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] nit0906 commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
nit0906 commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811116291
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 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.
Review comment:
build them*
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] thomasmueller merged pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
thomasmueller merged pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] chibulcuteanu commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
chibulcuteanu commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811133325
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 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.
Review comment:
what do you mean this is ignored? It's the only way to build an ES index after deploying the index definition directly on the repository (no oak-run).
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] thomasmueller commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
thomasmueller commented on a change in pull request #497:
URL: https://github.com/apache/jackrabbit-oak/pull/497#discussion_r811803245
##########
File path: oak-doc/src/site/markdown/query/elastic.md
##########
@@ -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
+
+ 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 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.
Review comment:
Ah sorry I thought it's ignored. Will remove it.
--
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [jackrabbit-oak] chibulcuteanu commented on a change in pull request #497: OAK-9699 Document Elastic Indexes
Posted by GitBox <gi...@apache.org>.
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-unsubscribe@jackrabbit.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org