Skip to content
Permalink
Browse files
trivial - add documentation for valueRegex and queryFilterRegex (#529)
  • Loading branch information
averma21 committed Mar 29, 2022
1 parent dae700d commit 353de172cd96ff2ef2577484ce842d78db6e6f95
Showing 1 changed file with 15 additions and 0 deletions.
@@ -146,6 +146,8 @@ Below is the canonical index definition structure
- codec (string)
- compatVersion (long) = 2
- evaluatePathRestrictions (boolean) = false
- valueRegex (string)
- queryFilterRegex (string)
- includedPaths (string) multiple
- queryPaths (string) multiple = ['/']
- excludedPaths (string) multiple
@@ -191,6 +193,19 @@ evaluatePathRestrictions
: Optional boolean property defaults to `false`.
: If enabled the index can evaluate [path restrictions](#path-restrictions)

valueRegex
: Optional string property
: A regular expression for property value in index definition. If this is specified,
then only those properties would be added to index whose value matches the regex
defined by this property.

queryFilterRegex
: Optional string property
: A regular expression for query text. If this property is present in an index definition,
then those queries whose search text doesn't match this pattern but are still using the index will log a warning.
If this property is not specified, but valueRegex is specified, that property is also used for the use
case specified here.

includedPaths
: Optional multi value property. Defaults to '/'.
: List of paths which should be included in the index.

0 comments on commit 353de17

Please sign in to comment.