honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Docs] Add description of simple query string flags (#36211) 

Closes #34944
This commit is contained in:
Christoph Büscher 2018-12-10 01:00:42 +01:00 committed by GitHub
parent f4aac8d3f1
commit a42502df8b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/reference/query-dsl/simple-query-string-query.asciidoc
View File

@ -46,8 +46,8 @@ with default operator of `AND`, the same query is translated to
|`analyzer` |Force the analyzer to use to analyze each term of the query when |`analyzer` |Force the analyzer to use to analyze each term of the query when
creating composite queries. creating composite queries.
|`flags` |Flags specifying which features of the `simple_query_string` to |`flags` |A set of <<supported-flags,flags>> specifying which features of the
enable. Defaults to `ALL`. `simple_query_string` to enable. Defaults to `ALL`.
|`analyze_wildcard` | Whether terms of prefix queries should be automatically |`analyze_wildcard` | Whether terms of prefix queries should be automatically
analyzed or not. If `true` a best effort will be made to analyze the prefix. However, analyzed or not. If `true` a best effort will be made to analyze the prefix. However,
@ -153,6 +153,7 @@ GET /_search
// CONSOLE // CONSOLE
[float] [float]
[[supported-flags]]
==== Flags ==== Flags
`simple_query_string` support multiple flags to specify which parsing features `simple_query_string` support multiple flags to specify which parsing features
should be enabled. It is specified as a `|`-delimited string with the should be enabled. It is specified as a `|`-delimited string with the
@ -172,8 +173,25 @@ GET /_search
-------------------------------------------------- --------------------------------------------------
// CONSOLE // CONSOLE
The available flags are: `ALL`, `NONE`, `AND`, `OR`, `NOT`, `PREFIX`, `PHRASE`, The available flags are:
`PRECEDENCE`, `ESCAPE`, `WHITESPACE`, `FUZZY`, `NEAR`, and `SLOP`.
[cols="<,<",options="header",]
|=======================================================================
|Flag |Description
|`ALL` |Enables all parsing features. This is the default.
|`NONE` |Switches off all parsing features.
|`AND` |Enables the `+` AND operator.
|`OR` |Enables the `\|` OR operator.
|`NOT` |Enables the `-` NOT operator.
|`PREFIX` |Enables the `*` Prefix operator.
|`PHRASE` |Enables the `"` quotes operator used to search for phrases.
|`PRECEDENCE` |Enables the `(` and `)` operators to control operator precedence.
|`ESCAPE` |Enables `\` as the escape character.
|`WHITESPACE` |Enables whitespaces as split characters.
|`FUZZY` |Enables the `~N` operator after a word where N is an integer denoting the allowed edit distance for matching (see <<fuzziness>>).
|`SLOP` |Enables the `~N` operator after a phrase where N is an integer denoting the slop amount.
|`NEAR` |Synonymous to `SLOP`.
|=======================================================================
[float] [float]
==== Synonyms ==== Synonyms