root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/query-languages/esql/_snippets/functions/functionNamedParams/qstr.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

68 lines
2.7 KiB
Markdown
Raw Normal View History

ESQL: Fix misspelling in generated docs (#129789) Pulled from #128576 so it's easier to review.
2025-06-21 03:42:37 +08:00
% This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.
ESQL autogenerate docs v3 (#124312) Building on the work started in https://github.com/elastic/elasticsearch/pull/123904, we now want to auto-generate most of the small subfiles from the ES|QL functions unit tests. This work also investigates any remaining discrepancies between the original asciidoc version and the new markdown, and tries to minimize differences so the docs do not look too different. The kibana json and markdown files are moved to a new location, and the operator docs are a little more generated than before (although still largely manual).
2025-03-13 21:16:46 +08:00
**Supported function named parameters**
Additional support for docs for ES|QL operators and version-specific differentiation (#125251) This PR was originally focused on improving support for Kibana docs, in particular the missing operator docs, but it has expanded to cover a bunch of related things: * Primarily the main work was to improve operators support. ESQL generated docs cover all functions and most operators for which their is a clear operator class and test class. However, some are built-in behaviour and need additional support. This PR adds more generated content for those operators. * Various specific operators requested by Kibana: Cast & null-predicates, and in particular the addition of examples * Two functions without examples: mv_append and to_date_nanos * Many small visual document cleanups (spelling, grammar, capitalization, etc.) * Initial support for `applies_to` for multi-version differentiation. This last point requires more work, as it is not yet agreed on just how we want this to look. We'll probably need to do refinements in followup PR. Consider the version in this PR as a first step into how this could look.
2025-03-24 16:56:45 +08:00
`max_determinized_states`
: (integer) Maximum number of automaton states required for the query. Default is 10000.
`fuzziness`
: (keyword) Maximum edit distance allowed for matching.
`auto_generate_synonyms_phrase_query`
: (boolean) If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.
`phrase_slop`
: (integer) Maximum number of positions allowed between matching tokens for phrases. Defaults to 0 (which means exact matches are required).
`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.
`minimum_should_match`
: (string) Minimum number of clauses that must match for a document to be returned.
`fuzzy_transpositions`
: (boolean) If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.
`fuzzy_prefix_length`
: (integer) Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.
`time_zone`
: (keyword) Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.
`lenient`
: (boolean) If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.
`rewrite`
: (keyword) Method used to rewrite the query.
`default_operator`
: (keyword) Default boolean logic used to interpret text in the query string if no operators are specified.
`analyzer`
: (keyword) Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the default_field.
`fuzzy_max_expansions`
: (integer) Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.
`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.
`allow_wildcard`
ESQL: Claim transport version to backport #124913 (#127616) Claims a transport version in main that we will use to backport #124913 to 8.19.
2025-05-02 05:27:42 +08:00
: (boolean) If true, the query attempts to analyze wildcard terms in the query string. Defaults to false.
Additional support for docs for ES|QL operators and version-specific differentiation (#125251) This PR was originally focused on improving support for Kibana docs, in particular the missing operator docs, but it has expanded to cover a bunch of related things: * Primarily the main work was to improve operators support. ESQL generated docs cover all functions and most operators for which their is a clear operator class and test class. However, some are built-in behaviour and need additional support. This PR adds more generated content for those operators. * Various specific operators requested by Kibana: Cast & null-predicates, and in particular the addition of examples * Two functions without examples: mv_append and to_date_nanos * Many small visual document cleanups (spelling, grammar, capitalization, etc.) * Initial support for `applies_to` for multi-version differentiation. This last point requires more work, as it is not yet agreed on just how we want this to look. We'll probably need to do refinements in followup PR. Consider the version in this PR as a first step into how this could look.
2025-03-24 16:56:45 +08:00
`boost`
: (float) Floating point number used to decrease or increase the relevance scores of the query.
`quote_field_suffix`
: (keyword) Suffix appended to quoted text in the query string.
`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 (*).