ES|QL QSTR function

Performs a query string query and returns true if it matches the row.

query

Query string in Lucene query string format.

options

(Optional) Additional options for Query String as function named parameters. See query string query for more information.

Performs a query string query. Returns true if the provided query string matches the row.

default_field

(keyword) Default field to search if no field is provided in the query string. Supports wildcards (*).

allow_leading_wildcard

(boolean) If true, the wildcard characters * and ? are allowed as the first character of the query string. Defaults to true.

analyze_wildcard

(boolean) If true, the query attempts to analyze wildcard terms in the query string. Defaults to false.

analyzer

(keyword) Analyzer used to convert the text in the query value into tokens. Defaults to the index-time analyzer mapped for the default_field.

auto_generate_synonyms_phrase_query

(boolean) If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.

fuzziness

(keyword) Maximum edit distance allowed for matching.

boost

(float) Floating point number used to decrease or increase the relevance scores of the query.

default_operator

(keyword) Default boolean logic used to interpret text in the query string if no operators are specified.

enable_position_increments

(boolean) If true, enable position increments in queries constructed from a query_string search. Defaults to true.

fields

(keyword) Array of fields to search. Supports wildcards (*).

fuzzy_max_expansions

(integer) Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.

fuzzy_prefix_length

(integer) Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.

fuzzy_transpositions

(boolean) If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.

lenient

(boolean) If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.

max_determinized_states

(integer) Maximum number of automaton states required for the query. Default is 10000.

minimum_should_match

(string) Minimum number of clauses that must match for a document to be returned.

quote_analyzer

(keyword) Analyzer used to convert quoted text in the query string into tokens. Defaults to the search_quote_analyzer mapped for the default_field.

phrase_slop

(integer) Maximum number of positions allowed between matching tokens for phrases. Defaults to 0 (which means exact matches are required).

quote_field_suffix

(keyword) Suffix appended to quoted text in the query string.

rewrite

(keyword) Method used to rewrite the query.

time_zone

(keyword) Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.

FROM books
| WHERE QSTR("author: Faulkner")

FROM books
| WHERE QSTR("title: Hobbjt~", {"fuzziness": 2})