You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by to...@apache.org on 2015/06/12 17:24:50 UTC
svn commit: r1685103 -
/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md
Author: tommaso
Date: Fri Jun 12 15:24:50 2015
New Revision: 1685103
URL: http://svn.apache.org/r1685103
Log:
OAK-2175, OAK-2176, OAK-2958 - added Lucene specific documentation for spellchecking and suggestions, linked to the main query doc page
Modified:
jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md
Modified: jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md?rev=1685103&r1=1685102&r2=1685103&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md (original)
+++ jackrabbit/oak/trunk/oak-doc/src/site/markdown/query/lucene.md Fri Jun 12 15:24:50 2015
@@ -792,6 +792,28 @@ mentioned steps
From the Luke UI shown you can access various details.
+#### Advanced search features
+
+##### Suggestions
+
+`@since Oak 1.1.17, 1.0.15`
+
+In order to use Lucene index to perform search suggestions, the index definition node (the one of type `oak:queryIndexConfiguration`)
+ needs to have the `compatVersion` set to `2`, then one or more property nodes, depending on use case, need to have the
+ property `useForSuggest` set to `true`, such setting controls from which properties terms to be used for suggestions will be taken.
+
+Once the above configuration has been done, by default, the Lucene suggester is updated every 10 minutes but that can be
+changed by setting the property `suggestUpdateFrequencyMinutes` in the index definition node to a different value.
+
+##### Spellchecking
+
+`@since Oak 1.1.17, 1.0.15`
+
+In order to use Lucene index to perform spellchecking, the index definition node (the one of type `oak:queryIndexConfiguration`)
+ needs to have the `compatVersion` set to `2`, then one or more property nodes, depending on use case, need to have the
+ property `useForSpellcheck` set to `true`, such setting controls from which properties terms to be used for spellcheck
+ corrections will be taken.
+
### Design Considerations
Lucene index provides quite a few features to meet various query requirements.