diff --git a/docs/reference/query-languages/esql/_snippets/functions/description/match.md b/docs/reference/query-languages/esql/_snippets/functions/description/match.md index 9f1701f31a722..fb24285faf58e 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/description/match.md +++ b/docs/reference/query-languages/esql/_snippets/functions/description/match.md @@ -2,5 +2,17 @@ **Description** -Use `MATCH` to perform a [match query](/reference/query-languages/query-dsl/query-dsl-match-query.md) on the specified field. Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL. Match can be used on fields from the text family like [text](/reference/elasticsearch/mapping-reference/text.md) and [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md), as well as other field types like keyword, boolean, dates, and numeric types. When Match is used on a [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md) field, it will perform a semantic query on the field. Match can use [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params) to specify additional options for the match query. All [match query parameters](/reference/query-languages/query-dsl/query-dsl-match-query.md#match-field-params) are supported. For a simplified syntax, you can use the [match operator](/reference/query-languages/esql/functions-operators/operators.md#esql-match-operator) `:` operator instead of `MATCH`. `MATCH` returns true if the provided query matches the row. +Use `MATCH` to perform a [match query](/reference/query-languages/query-dsl/query-dsl-match-query.md) on the specified field. Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL. + +Match can be used on fields from the text family like [text](/reference/elasticsearch/mapping-reference/text.md) and [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md), +as well as other field types like keyword, boolean, dates, and numeric types. +When Match is used on a [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md) field, it will perform a semantic query on the field. + +Match can use [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params) to specify additional options +for the match query. +All [match query parameters](/reference/query-languages/query-dsl/query-dsl-match-query.md#match-field-params) are supported. + +For a simplified syntax, you can use the [match operator](/reference/query-languages/esql/functions-operators/operators.md#esql-match-operator) `:` operator instead of `MATCH`. + +`MATCH` returns true if the provided query matches the row. diff --git a/docs/reference/query-languages/esql/_snippets/functions/description/match_phrase.md b/docs/reference/query-languages/esql/_snippets/functions/description/match_phrase.md index cc218a203b5f3..528c4011f6eb4 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/description/match_phrase.md +++ b/docs/reference/query-languages/esql/_snippets/functions/description/match_phrase.md @@ -2,5 +2,14 @@ **Description** -Use `MATCH_PHRASE` to perform a [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) on the specified field. Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL. MatchPhrase can be used on [text](/reference/elasticsearch/mapping-reference/text.md) fields, as well as other field types like keyword, boolean, or date types. MatchPhrase is not supported for [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md) or numeric types. MatchPhrase can use [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params) to specify additional options for the match_phrase query. All [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) query parameters are supported. `MATCH_PHRASE` returns true if the provided query matches the row. +Use `MATCH_PHRASE` to perform a [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) on the specified field. Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL. + +MatchPhrase can be used on [text](/reference/elasticsearch/mapping-reference/text.md) fields, as well as other field types like keyword, boolean, or date types. +MatchPhrase is not supported for [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md) or numeric types. + +MatchPhrase can use [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params) to specify additional options for the +match_phrase query. +All [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) query parameters are supported. + +`MATCH_PHRASE` returns true if the provided query matches the row. diff --git a/docs/reference/query-languages/esql/_snippets/functions/examples/match_phrase.md b/docs/reference/query-languages/esql/_snippets/functions/examples/match_phrase.md index 4e7e3f6a8a30b..b02abb05d15f5 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/examples/match_phrase.md +++ b/docs/reference/query-languages/esql/_snippets/functions/examples/match_phrase.md @@ -2,6 +2,10 @@ **Example** +```{applies_to} +stack: ga 9.1.0 +``` + ```esql FROM books | WHERE MATCH_PHRASE(author, "William Faulkner") diff --git a/docs/reference/query-languages/esql/_snippets/functions/examples/qstr.md b/docs/reference/query-languages/esql/_snippets/functions/examples/qstr.md index dbeff03c0f12f..906611c42d9ba 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/examples/qstr.md +++ b/docs/reference/query-languages/esql/_snippets/functions/examples/qstr.md @@ -15,6 +15,10 @@ FROM books | 2883 | William Faulkner | | 3293 | Danny Faulkner | +```{applies_to} +stack: ga 9.1.0 +``` + ```esql FROM books | WHERE QSTR("title: Hobbjt~", {"fuzziness": 2}) diff --git a/docs/reference/query-languages/esql/_snippets/functions/examples/to_lower.md b/docs/reference/query-languages/esql/_snippets/functions/examples/to_lower.md index 6ca4750e29ba6..8f15bc3d8dbf3 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/examples/to_lower.md +++ b/docs/reference/query-languages/esql/_snippets/functions/examples/to_lower.md @@ -11,6 +11,10 @@ ROW message = "Some Text" | --- | --- | | Some Text | some text | +```{applies_to} +stack: ga 9.1.0 +``` + ```esql ROW v = TO_LOWER(["Some", "Text"]) ``` diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/kql.md b/docs/reference/query-languages/esql/_snippets/functions/layout/kql.md index 9c54e63858946..3ebbb86154e10 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/kql.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/kql.md @@ -1,12 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `KQL` [esql-kql] -:::{warning} -Do not use on production environments. This functionality is in technical preview and -may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview -are not subject to the support SLA of official GA features. -::: - +```{applies_to} +stack: preview 9.0.0 +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/match.md b/docs/reference/query-languages/esql/_snippets/functions/layout/match.md index df0b2c48200f4..585822c2219ac 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/match.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/match.md @@ -1,16 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `MATCH` [esql-match] -:::{warning} -Do not use on production environments. This functionality is in technical preview and -may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview -are not subject to the support SLA of official GA features. -::: - -:::{note} -###### Serverless: GA, Elastic Stack: COMING -Support for optional named parameters is only available in serverless, or in a future {{es}} release -::: +```{applies_to} +stack: preview 9.0.0 +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/match_phrase.md b/docs/reference/query-languages/esql/_snippets/functions/layout/match_phrase.md index a9cd51e7df916..04cf9356ba140 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/match_phrase.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/match_phrase.md @@ -1,16 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `MATCH_PHRASE` [esql-match_phrase] -:::{warning} -Do not use on production environments. This functionality is in technical preview and -may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview -are not subject to the support SLA of official GA features. -::: - -:::{note} -###### Serverless: GA, Elastic Stack: COMING -Support for optional named parameters is only available in serverless, or in a future {{es}} release -::: +```{applies_to} +stack: preview 9.1.0 +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/multi_match.md b/docs/reference/query-languages/esql/_snippets/functions/layout/multi_match.md index a4cd79d9ce1fc..bdc2d072a17b4 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/multi_match.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/multi_match.md @@ -1,16 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `MULTI_MATCH` [esql-multi_match] -:::{warning} -Do not use on production environments. This functionality is in technical preview and -may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview -are not subject to the support SLA of official GA features. -::: - -:::{note} -###### Serverless: GA, Elastic Stack: COMING 9.1.0 -Support for optional named parameters is only available from 9.1.0 -::: +```{applies_to} +stack: coming 9.1.0 +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/qstr.md b/docs/reference/query-languages/esql/_snippets/functions/layout/qstr.md index a5f7abacb12f0..62c268a2cf812 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/qstr.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/qstr.md @@ -1,16 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `QSTR` [esql-qstr] -:::{warning} -Do not use on production environments. This functionality is in technical preview and -may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview -are not subject to the support SLA of official GA features. -::: - -:::{note} -###### Serverless: GA, Elastic Stack: COMING -Support for optional named parameters is only available in serverless, or in a future {{es}} release -::: +```{applies_to} +stack: preview 9.0.0 +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/round_to.md b/docs/reference/query-languages/esql/_snippets/functions/layout/round_to.md index c6370fd1a94c7..7945c0d7fceef 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/round_to.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/round_to.md @@ -2,8 +2,7 @@ ## `ROUND_TO` [esql-round_to] ```{applies_to} -product: COMING 8.19.0/9.1.0 -serverless: GA +stack: preview 9.1.0 ``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_centroid_agg.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_centroid_agg.md index 6e4416bb791d2..8352c6c5c3d99 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_centroid_agg.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_centroid_agg.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `ST_CENTROID_AGG` [esql-st_centroid_agg] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_envelope.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_envelope.md index 43c5a47eaa6ff..d4a6b29743a70 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_envelope.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_envelope.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `ST_ENVELOPE` [esql-st_envelope] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_extent_agg.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_extent_agg.md index 315c96f5d1213..1581402da617f 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_extent_agg.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_extent_agg.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `ST_EXTENT_AGG` [esql-st_extent_agg] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash.md index 1a666ea0fdca4..586d038a9563d 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `ST_GEOHASH` [esql-st_geohash] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_long.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_long.md index c4f442747334f..03f251812bd02 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_long.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_long.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_GEOHASH_TO_LONG` [esql-st_geohash_to_long] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_string.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_string.md index 9a62143bd03a6..b85283545a533 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_string.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohash_to_string.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_GEOHASH_TO_STRING` [esql-st_geohash_to_string] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex.md index 5eca3553ab3f8..0f1a6629b77d5 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `ST_GEOHEX` [esql-st_geohex] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_long.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_long.md index e4dd365d5a3d2..732fa68504391 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_long.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_long.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_GEOHEX_TO_LONG` [esql-st_geohex_to_long] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_string.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_string.md index 603f22e8b9ab8..689484e97a8a3 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_string.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geohex_to_string.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_GEOHEX_TO_STRING` [esql-st_geohex_to_string] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile.md index 91e2a36985947..85bc55c5bd85f 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `ST_GEOTILE` [esql-st_geotile] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_long.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_long.md index 3b66ccfa67102..ea3e8f76775df 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_long.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_long.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_GEOTILE_TO_LONG` [esql-st_geotile_to_long] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_string.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_string.md index 3e3ca193a4628..4cea1dd5225f1 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_string.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_geotile_to_string.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_GEOTILE_TO_STRING` [esql-st_geotile_to_string] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmax.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmax.md index 48e91a95554ac..0744e1faf4ec3 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmax.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmax.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_XMAX` [esql-st_xmax] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmin.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmin.md index 589fcbd0f3282..c4b79485348d4 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmin.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_xmin.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_XMIN` [esql-st_xmin] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymax.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymax.md index 9e305abcc37c4..0c3457f9ade90 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymax.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymax.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_YMAX` [esql-st_ymax] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymin.md b/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymin.md index de04ab81fdd56..46fcbc012b42a 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymin.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/st_ymin.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ### `ST_YMIN` [esql-st_ymin] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/term.md b/docs/reference/query-languages/esql/_snippets/functions/layout/term.md index 4d60f9e1ab57f..5c386f0c03e6f 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/term.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/term.md @@ -1,12 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `TERM` [esql-term] -:::{warning} -Do not use on production environments. This functionality is in technical preview and -may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview -are not subject to the support SLA of official GA features. -::: - +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/to_aggregate_metric_double.md b/docs/reference/query-languages/esql/_snippets/functions/layout/to_aggregate_metric_double.md index 55fd25dede518..866a63a46de51 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/to_aggregate_metric_double.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/to_aggregate_metric_double.md @@ -2,8 +2,7 @@ ## `TO_AGGREGATE_METRIC_DOUBLE` [esql-to_aggregate_metric_double] ```{applies_to} -product: COMING -serverless: GA +stack: coming ``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/to_lower.md b/docs/reference/query-languages/esql/_snippets/functions/layout/to_lower.md index 0c6e41daaf077..6ebd5b0124cb8 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/to_lower.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/to_lower.md @@ -1,10 +1,6 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `TO_LOWER` [esql-to_lower] -:::{note} -###### Serverless: GA, Elastic Stack: COMING 9.1.0 -Support for multivalued parameters is only available from 9.1.0 -::: **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/to_unsigned_long.md b/docs/reference/query-languages/esql/_snippets/functions/layout/to_unsigned_long.md index 9ee147b1ec225..3e7a852070054 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/to_unsigned_long.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/to_unsigned_long.md @@ -1,6 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `TO_UNSIGNED_LONG` [esql-to_unsigned_long] +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/to_upper.md b/docs/reference/query-languages/esql/_snippets/functions/layout/to_upper.md index a5f044ecb381c..49e5b1b657644 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/to_upper.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/to_upper.md @@ -1,10 +1,6 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `TO_UPPER` [esql-to_upper] -:::{note} -###### Serverless: GA, Elastic Stack: COMING 9.1.0 -Support for multivalued parameters is only available from 9.1.0 -::: **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/layout/values.md b/docs/reference/query-languages/esql/_snippets/functions/layout/values.md index cf2d85cb7cd0b..fe6e77fd1ddf5 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/layout/values.md +++ b/docs/reference/query-languages/esql/_snippets/functions/layout/values.md @@ -1,12 +1,10 @@ % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `VALUES` [esql-values] -:::{warning} -Do not use on production environments. This functionality is in technical preview and -may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview -are not subject to the support SLA of official GA features. -::: - +```{applies_to} +stack: preview +serverless: preview +``` **Syntax** diff --git a/docs/reference/query-languages/esql/_snippets/functions/parameters/match.md b/docs/reference/query-languages/esql/_snippets/functions/parameters/match.md index bded0945d5445..c3f229589e9c6 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/parameters/match.md +++ b/docs/reference/query-languages/esql/_snippets/functions/parameters/match.md @@ -9,5 +9,5 @@ : Value to find in the provided field. `options` -: (Optional) Match additional options as [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params). See [match query](/reference/query-languages/query-dsl/query-dsl-match-query.md) for more information. +: (Optional) Match additional options as [function named parameters](/reference/query-languages/esql/esql-syntax.md#esql-function-named-params). diff --git a/docs/reference/query-languages/esql/_snippets/functions/parameters/to_lower.md b/docs/reference/query-languages/esql/_snippets/functions/parameters/to_lower.md index 8d39b91c418fb..d35a8bace2317 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/parameters/to_lower.md +++ b/docs/reference/query-languages/esql/_snippets/functions/parameters/to_lower.md @@ -3,5 +3,5 @@ **Parameters** `str` -: String expression. If `null`, the function returns `null`. The input can be a single- or multi-valued column or an expression. +: String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, or a multi-valued column or expression {applies_to}`stack: ga 9.1.0`. diff --git a/docs/reference/query-languages/esql/_snippets/functions/parameters/to_upper.md b/docs/reference/query-languages/esql/_snippets/functions/parameters/to_upper.md index 8d39b91c418fb..d35a8bace2317 100644 --- a/docs/reference/query-languages/esql/_snippets/functions/parameters/to_upper.md +++ b/docs/reference/query-languages/esql/_snippets/functions/parameters/to_upper.md @@ -3,5 +3,5 @@ **Parameters** `str` -: String expression. If `null`, the function returns `null`. The input can be a single- or multi-valued column or an expression. +: String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, or a multi-valued column or expression {applies_to}`stack: ga 9.1.0`. diff --git a/docs/reference/query-languages/esql/_snippets/lists/type-conversion-functions.md b/docs/reference/query-languages/esql/_snippets/lists/type-conversion-functions.md index 59da01b8578db..8867386f00a2d 100644 --- a/docs/reference/query-languages/esql/_snippets/lists/type-conversion-functions.md +++ b/docs/reference/query-languages/esql/_snippets/lists/type-conversion-functions.md @@ -1,7 +1,7 @@ * [`TO_BOOLEAN`](../../functions-operators/type-conversion-functions.md#esql-to_boolean) * [`TO_CARTESIANPOINT`](../../functions-operators/type-conversion-functions.md#esql-to_cartesianpoint) * [`TO_CARTESIANSHAPE`](../../functions-operators/type-conversion-functions.md#esql-to_cartesianshape) -* [preview] [`TO_DATEPERIOD`](../../functions-operators/type-conversion-functions.md#esql-to_dateperiod) +* [`TO_DATEPERIOD`](../../functions-operators/type-conversion-functions.md#esql-to_dateperiod) * [`TO_DATETIME`](../../functions-operators/type-conversion-functions.md#esql-to_datetime) * [`TO_DATE_NANOS`](../../functions-operators/type-conversion-functions.md#esql-to_date_nanos) * [`TO_DEGREES`](../../functions-operators/type-conversion-functions.md#esql-to_degrees) @@ -13,6 +13,6 @@ * [`TO_LONG`](../../functions-operators/type-conversion-functions.md#esql-to_long) * [`TO_RADIANS`](../../functions-operators/type-conversion-functions.md#esql-to_radians) * [`TO_STRING`](../../functions-operators/type-conversion-functions.md#esql-to_string) -* [preview] [`TO_TIMEDURATION`](../../functions-operators/type-conversion-functions.md#esql-to_timeduration) +* [`TO_TIMEDURATION`](../../functions-operators/type-conversion-functions.md#esql-to_timeduration) * [preview] [`TO_UNSIGNED_LONG`](../../functions-operators/type-conversion-functions.md#esql-to_unsigned_long) * [`TO_VERSION`](../../functions-operators/type-conversion-functions.md#esql-to_version) diff --git a/docs/reference/query-languages/esql/_snippets/operators/layout/match_operator.md b/docs/reference/query-languages/esql/_snippets/operators/layout/match_operator.md index 3f9acb7d89738..c692aefe61579 100644 --- a/docs/reference/query-languages/esql/_snippets/operators/layout/match_operator.md +++ b/docs/reference/query-languages/esql/_snippets/operators/layout/match_operator.md @@ -1,4 +1,8 @@ ### Match operator (`:`) [esql-match-operator] +```{applies_to} +stack: preview 9.0.0 +serverless: preview +``` The only search operator is match (`:`). diff --git a/docs/reference/query-languages/esql/functions-operators/spatial-functions.md b/docs/reference/query-languages/esql/functions-operators/spatial-functions.md index 806e5e8157a63..60746205e60e4 100644 --- a/docs/reference/query-languages/esql/functions-operators/spatial-functions.md +++ b/docs/reference/query-languages/esql/functions-operators/spatial-functions.md @@ -47,4 +47,3 @@ mapped_pages: :::{include} ../_snippets/functions/layout/st_ymin.md ::: - diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/match.json b/docs/reference/query-languages/esql/kibana/definition/functions/match.json index ae46fdf7bee9d..713327c40b55a 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/match.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/match.json @@ -2,7 +2,7 @@ "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.", "type" : "scalar", "name" : "match", - "description" : "Use `MATCH` to perform a match query on the specified field.\nUsing `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.\n\nMatch can be used on fields from the text family like text and semantic_text,\nas well as other field types like keyword, boolean, dates, and numeric types.\nWhen Match is used on a semantic_text field, it will perform a semantic query on the field.\n\nMatch can use function named parameters to specify additional options for the match query.\nAll match query parameters are supported.\n\nFor a simplified syntax, you can use the match operator `:` operator instead of `MATCH`.\n\n`MATCH` returns true if the provided query matches the row.", + "description" : "Use `MATCH` to perform a match query on the specified field.\nUsing `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.", "signatures" : [ { "params" : [ @@ -23,7 +23,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -48,7 +48,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -73,7 +73,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -98,7 +98,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -123,7 +123,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -148,7 +148,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -173,7 +173,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -198,7 +198,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -223,7 +223,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -248,7 +248,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -273,7 +273,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -298,7 +298,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -323,7 +323,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -348,7 +348,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -373,7 +373,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -398,7 +398,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -423,7 +423,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -448,7 +448,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -473,7 +473,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -498,7 +498,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -523,7 +523,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -548,7 +548,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -573,7 +573,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -598,7 +598,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -623,7 +623,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -648,7 +648,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -673,7 +673,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -698,7 +698,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, @@ -723,7 +723,7 @@ "type" : "function_named_parameters", "mapParams" : "{name='fuzziness', values=[AUTO, 1, 2], description='Maximum edit distance allowed for matching.'}, {name='auto_generate_synonyms_phrase_query', values=[true, false], description='If true, match phrase queries are automatically created for multi-term synonyms. Defaults to true.'}, {name='analyzer', values=[standard], description='Analyzer used to convert the text in the query value into token. Defaults to the index-time analyzer mapped for the field. If no analyzer is mapped, the index’s default analyzer is used.'}, {name='minimum_should_match', values=[2], description='Minimum number of clauses that must match for a document to be returned.'}, {name='zero_terms_query', values=[none, all], description='Indicates whether all documents or none are returned if the analyzer removes all tokens, such as when using a stop filter. Defaults to none.'}, {name='boost', values=[2.5], description='Floating point number used to decrease or increase the relevance scores of the query. Defaults to 1.0.'}, {name='fuzzy_transpositions', values=[true, false], description='If true, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba). Defaults to true.'}, {name='fuzzy_rewrite', values=[constant_score_blended, constant_score, constant_score_boolean, top_terms_blended_freqs_N, top_terms_boost_N, top_terms_N], description='Method used to rewrite the query. See the rewrite parameter for valid values and more information. If the fuzziness parameter is not 0, the match query uses a fuzzy_rewrite method of top_terms_blended_freqs_${max_expansions} by default.'}, {name='prefix_length', values=[1], description='Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.'}, {name='lenient', values=[true, false], description='If false, format-based errors, such as providing a text query value for a numeric field, are returned. Defaults to false.'}, {name='operator', values=[AND, OR], description='Boolean logic used to interpret text in the query value. Defaults to OR.'}, {name='max_expansions', values=[50], description='Maximum number of terms to which the query will expand. Defaults to 50.'}", "optional" : true, - "description" : "(Optional) Match additional options as <>. See <> for more information." + "description" : "(Optional) Match additional options as <>." } ], "variadic" : false, diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/match_phrase.json b/docs/reference/query-languages/esql/kibana/definition/functions/match_phrase.json index c138616584ad9..d05c8e76bfecf 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/match_phrase.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/match_phrase.json @@ -2,7 +2,7 @@ "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.", "type" : "scalar", "name" : "match_phrase", - "description" : "Use `MATCH_PHRASE` to perform a `match_phrase` on the\nspecified field.\nUsing `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.\n\nMatchPhrase can be used on text fields, as well as other field types like keyword, boolean, or date types.\nMatchPhrase is not supported for semantic_text or numeric types.\n\nMatchPhrase can use function named parameters to specify additional options for the\nmatch_phrase query.\nAll `match_phrase` query parameters are supported.\n\n`MATCH_PHRASE` returns true if the provided query matches the row.", + "description" : "Use `MATCH_PHRASE` to perform a `match_phrase` on the\nspecified field.\nUsing `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.", "signatures" : [ { "params" : [ diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_centroid_agg.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_centroid_agg.json index 3357a52cdf7f4..ed7e44e27e0cb 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_centroid_agg.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_centroid_agg.json @@ -32,6 +32,6 @@ "examples" : [ "FROM airports\n| STATS centroid=ST_CENTROID_AGG(location)" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_envelope.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_envelope.json index 9d8538f42d712..d24edbcab7c09 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_envelope.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_envelope.json @@ -56,6 +56,6 @@ "examples" : [ "FROM airport_city_boundaries\n| WHERE abbrev == \"CPH\"\n| EVAL envelope = ST_ENVELOPE(city_boundary)\n| KEEP abbrev, airport, envelope" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_extent_agg.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_extent_agg.json index 6198b184262e3..6364a3cfe631e 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_extent_agg.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_extent_agg.json @@ -58,6 +58,6 @@ "examples" : [ "FROM airports\n| WHERE country == \"India\"\n| STATS extent = ST_EXTENT_AGG(location)" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash.json index e019d408667ef..d2fc83008c150 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash.json @@ -50,6 +50,6 @@ "examples" : [ "FROM airports\n| EVAL geohash = ST_GEOHASH(location, 1)\n| STATS\n count = COUNT(*),\n centroid = ST_CENTROID_AGG(location)\n BY geohash\n| WHERE count >= 10\n| EVAL geohashString = ST_GEOHASH_TO_STRING(geohash)\n| KEEP count, centroid, geohashString\n| SORT count DESC, geohashString ASC" ], - "preview" : false, + "preview" : true, "snapshot_only" : true -} +} \ No newline at end of file diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_long.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_long.json index 024d03b16e6be..6bbda7aa19d85 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_long.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_long.json @@ -32,6 +32,6 @@ "examples" : [ "ROW geohash = \"u3bu\"\n| EVAL geohashLong = ST_GEOHASH_TO_LONG(geohash)" ], - "preview" : false, + "preview" : true, "snapshot_only" : true } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_string.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_string.json index dc3c6529f07eb..76131683932db 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_string.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohash_to_string.json @@ -32,6 +32,6 @@ "examples" : [ "ROW geohash = TO_LONG(13686180)\n| EVAL geohashString = ST_GEOHASH_TO_STRING(geohash)" ], - "preview" : false, + "preview" : true, "snapshot_only" : true } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex.json index cd0d7d3b82f1c..9a3a04cb0a7f8 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex.json @@ -53,6 +53,6 @@ "examples" : [ "FROM airports\n| EVAL geohex = ST_GEOHEX(location, 1)\n| STATS\n count = COUNT(*),\n centroid = ST_CENTROID_AGG(location)\n BY geohex\n| WHERE count >= 10\n| EVAL geohexString = ST_GEOHEX_TO_STRING(geohex)\n| KEEP count, centroid, geohexString\n| SORT count DESC, geohexString ASC" ], - "preview" : false, + "preview" : true, "snapshot_only" : true -} +} \ No newline at end of file diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_long.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_long.json index b08a5c62e5a47..52c7918a0c3ad 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_long.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_long.json @@ -32,6 +32,6 @@ "examples" : [ "ROW geohex = \"841f059ffffffff\"\n| EVAL geohexLong = ST_GEOHEX_TO_LONG(geohex)" ], - "preview" : false, + "preview" : true, "snapshot_only" : true -} +} \ No newline at end of file diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_string.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_string.json index e787931fdb8e1..612b13691d40c 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_string.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geohex_to_string.json @@ -32,6 +32,6 @@ "examples" : [ "ROW geohex = 595020895127339007\n| EVAL geohexString = ST_GEOHEX_TO_STRING(geohex)" ], - "preview" : false, + "preview" : true, "snapshot_only" : true -} +} \ No newline at end of file diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile.json index 64e8f9cfea9ab..06df5e3076fea 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile.json @@ -50,6 +50,6 @@ "examples" : [ "FROM airports\n| EVAL geotile = ST_GEOTILE(location, 2)\n| STATS\n count = COUNT(*),\n centroid = ST_CENTROID_AGG(location)\n BY geotile\n| EVAL geotileString = ST_GEOTILE_TO_STRING(geotile)\n| SORT count DESC, geotileString ASC\n| KEEP count, centroid, geotileString" ], - "preview" : false, + "preview" : true, "snapshot_only" : true -} +} \ No newline at end of file diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_long.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_long.json index 407117a5c0b26..2eb49b5c320f9 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_long.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_long.json @@ -32,6 +32,6 @@ "examples" : [ "ROW geotile = \"4/8/5\"\n| EVAL geotileLong = ST_GEOTILE_TO_LONG(geotile)" ], - "preview" : false, + "preview" : true, "snapshot_only" : true -} +} \ No newline at end of file diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_string.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_string.json index c27faa68049de..df8e91514dc7b 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_string.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_geotile_to_string.json @@ -32,6 +32,6 @@ "examples" : [ "ROW geotile = 1152921508901814277\n| EVAL geotileString = ST_GEOTILE_TO_STRING(geotile)" ], - "preview" : false, + "preview" : true, "snapshot_only" : true -} +} \ No newline at end of file diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_xmax.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_xmax.json index 92111475a475a..a32f9b371cc73 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_xmax.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_xmax.json @@ -56,6 +56,6 @@ "examples" : [ "FROM airport_city_boundaries\n| WHERE abbrev == \"CPH\"\n| EVAL envelope = ST_ENVELOPE(city_boundary)\n| EVAL xmin = ST_XMIN(envelope), xmax = ST_XMAX(envelope), ymin = ST_YMIN(envelope), ymax = ST_YMAX(envelope)\n| KEEP abbrev, airport, xmin, xmax, ymin, ymax" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_xmin.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_xmin.json index 3ec828f424836..1569053eebe9e 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_xmin.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_xmin.json @@ -56,6 +56,6 @@ "examples" : [ "FROM airport_city_boundaries\n| WHERE abbrev == \"CPH\"\n| EVAL envelope = ST_ENVELOPE(city_boundary)\n| EVAL xmin = ST_XMIN(envelope), xmax = ST_XMAX(envelope), ymin = ST_YMIN(envelope), ymax = ST_YMAX(envelope)\n| KEEP abbrev, airport, xmin, xmax, ymin, ymax" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_ymax.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_ymax.json index 17c1ad6d5a7e3..18c83d795d5a5 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_ymax.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_ymax.json @@ -56,6 +56,6 @@ "examples" : [ "FROM airport_city_boundaries\n| WHERE abbrev == \"CPH\"\n| EVAL envelope = ST_ENVELOPE(city_boundary)\n| EVAL xmin = ST_XMIN(envelope), xmax = ST_XMAX(envelope), ymin = ST_YMIN(envelope), ymax = ST_YMAX(envelope)\n| KEEP abbrev, airport, xmin, xmax, ymin, ymax" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/st_ymin.json b/docs/reference/query-languages/esql/kibana/definition/functions/st_ymin.json index 97eb03d1efcca..89c5d38c25a3d 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/st_ymin.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/st_ymin.json @@ -56,6 +56,6 @@ "examples" : [ "FROM airport_city_boundaries\n| WHERE abbrev == \"CPH\"\n| EVAL envelope = ST_ENVELOPE(city_boundary)\n| EVAL xmin = ST_XMIN(envelope), xmax = ST_XMAX(envelope), ymin = ST_YMIN(envelope), ymax = ST_YMAX(envelope)\n| KEEP abbrev, airport, xmin, xmax, ymin, ymax" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/to_lower.json b/docs/reference/query-languages/esql/kibana/definition/functions/to_lower.json index 973697f826d36..cb1f059f04aca 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/to_lower.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/to_lower.json @@ -10,7 +10,7 @@ "name" : "str", "type" : "keyword", "optional" : false, - "description" : "String expression. If `null`, the function returns `null`. The input can be a single- or multi-valued column or an expression." + "description" : "String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, or a multi-valued column or expression. " } ], "variadic" : false, @@ -22,7 +22,7 @@ "name" : "str", "type" : "text", "optional" : false, - "description" : "String expression. If `null`, the function returns `null`. The input can be a single- or multi-valued column or an expression." + "description" : "String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, or a multi-valued column or expression. " } ], "variadic" : false, diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/to_unsigned_long.json b/docs/reference/query-languages/esql/kibana/definition/functions/to_unsigned_long.json index daa0ae689b5a9..ea10abb3b209f 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/to_unsigned_long.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/to_unsigned_long.json @@ -104,6 +104,6 @@ "examples" : [ "ROW str1 = \"2147483648\", str2 = \"2147483648.2\", str3 = \"foo\"\n| EVAL long1 = TO_UNSIGNED_LONG(str1), long2 = TO_ULONG(str2), long3 = TO_UL(str3)" ], - "preview" : false, + "preview" : true, "snapshot_only" : false } diff --git a/docs/reference/query-languages/esql/kibana/definition/functions/to_upper.json b/docs/reference/query-languages/esql/kibana/definition/functions/to_upper.json index 0f87045585f03..82e3f66a9cfe6 100644 --- a/docs/reference/query-languages/esql/kibana/definition/functions/to_upper.json +++ b/docs/reference/query-languages/esql/kibana/definition/functions/to_upper.json @@ -10,7 +10,7 @@ "name" : "str", "type" : "keyword", "optional" : false, - "description" : "String expression. If `null`, the function returns `null`. The input can be a single- or multi-valued column or an expression." + "description" : "String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, or a multi-valued column or expression. " } ], "variadic" : false, @@ -22,7 +22,7 @@ "name" : "str", "type" : "text", "optional" : false, - "description" : "String expression. If `null`, the function returns `null`. The input can be a single- or multi-valued column or an expression." + "description" : "String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, or a multi-valued column or expression. " } ], "variadic" : false, diff --git a/docs/reference/query-languages/esql/kibana/docs/functions/match.md b/docs/reference/query-languages/esql/kibana/docs/functions/match.md index e362a9a506c7b..116edb0cb37b5 100644 --- a/docs/reference/query-languages/esql/kibana/docs/functions/match.md +++ b/docs/reference/query-languages/esql/kibana/docs/functions/match.md @@ -4,17 +4,6 @@ Use `MATCH` to perform a [match query](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query) on the specified field. Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL. -Match can be used on fields from the text family like [text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/text) and [semantic_text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text), -as well as other field types like keyword, boolean, dates, and numeric types. -When Match is used on a [semantic_text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text) field, it will perform a semantic query on the field. - -Match can use [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params) to specify additional options for the match query. -All [match query parameters](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query#match-field-params) are supported. - -For a simplified syntax, you can use the [match operator](https://www.elastic.co/docs/reference/query-languages/esql/functions-operators/operators#esql-match-operator) `:` operator instead of `MATCH`. - -`MATCH` returns true if the provided query matches the row. - ```esql FROM books | WHERE MATCH(author, "Faulkner") diff --git a/docs/reference/query-languages/esql/kibana/docs/functions/match_phrase.md b/docs/reference/query-languages/esql/kibana/docs/functions/match_phrase.md index 30548b63ae8eb..a0a85e493b3b0 100644 --- a/docs/reference/query-languages/esql/kibana/docs/functions/match_phrase.md +++ b/docs/reference/query-languages/esql/kibana/docs/functions/match_phrase.md @@ -5,15 +5,6 @@ Use `MATCH_PHRASE` to perform a [`match_phrase`](https://www.elastic.co/docs/ref specified field. Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL. -MatchPhrase can be used on [text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/text) fields, as well as other field types like keyword, boolean, or date types. -MatchPhrase is not supported for [semantic_text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text) or numeric types. - -MatchPhrase can use [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params) to specify additional options for the -match_phrase query. -All [`match_phrase`](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase) query parameters are supported. - -`MATCH_PHRASE` returns true if the provided query matches the row. - ```esql FROM books | WHERE MATCH_PHRASE(author, "William Faulkner") diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/Example.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/Example.java index 32e7437d320bd..33a39aa8824c1 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/Example.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/Example.java @@ -34,6 +34,11 @@ */ String tag(); + /** + * If the example is applicable to only a capability available in a specific version + */ + String applies_to() default ""; + /** * The explanation that will appear after the example. */ diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialCentroid.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialCentroid.java index cf3ed8851b141..ac7475f9ca98a 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialCentroid.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialCentroid.java @@ -21,6 +21,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.FunctionType; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -45,6 +47,8 @@ public class SpatialCentroid extends SpatialAggregateFunction implements ToAggre @FunctionInfo( returnType = { "geo_point", "cartesian_point" }, + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Calculate the spatial centroid over a field with spatial point geometry type.", type = FunctionType.AGGREGATE, examples = @Example(file = "spatial", tag = "st_centroid_agg-airports") diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialExtent.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialExtent.java index fbf513ddc7f3a..9fe0d6a9b5474 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialExtent.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/SpatialExtent.java @@ -25,6 +25,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.FunctionType; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -48,6 +50,8 @@ public final class SpatialExtent extends SpatialAggregateFunction implements ToA @FunctionInfo( returnType = { "geo_shape", "cartesian_shape" }, + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Calculate the spatial extent over a field with geometry type. Returns a bounding box for all values of the field.", type = FunctionType.AGGREGATE, examples = @Example(file = "spatial", tag = "st_extent_agg-airports") diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Values.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Values.java index 721cdc0a55241..5eaab1fc77514 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Values.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/aggregate/Values.java @@ -23,6 +23,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.FunctionType; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -72,6 +74,7 @@ public class Values extends AggregateFunction implements ToAggregator { "long", "version" }, preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = """ Returns unique values as a multivalued field. The order of the returned values isn’t guaranteed. If you need the values returned in order use diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Kql.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Kql.java index 12dd7a7a5e904..cadab7faaf911 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Kql.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Kql.java @@ -17,6 +17,8 @@ import org.elasticsearch.xpack.esql.core.tree.NodeInfo; import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.io.stream.PlanStreamInput; @@ -36,6 +38,8 @@ public class Kql extends FullTextFunction { @FunctionInfo( returnType = "boolean", preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.0.0") }, + // @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") }, description = "Performs a KQL query. Returns true if the provided KQL query string matches the row.", examples = { @Example(file = "kql-function", tag = "kql-with-field") } ) diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java index 12193a9e2bf20..60dca4b8f1a7d 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java @@ -136,15 +136,18 @@ public class Match extends FullTextFunction implements OptionalArgument, PostAna @FunctionInfo( returnType = "boolean", preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.0.0") }, + // @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") }, description = """ Use `MATCH` to perform a <> on the specified field. - Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL. - + Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.""", + detailedDescription = """ Match can be used on fields from the text family like <> and <>, as well as other field types like keyword, boolean, dates, and numeric types. When Match is used on a <> field, it will perform a semantic query on the field. - Match can use <> to specify additional options for the match query. + Match can use <> to specify additional options + for the match query. All <> are supported. For a simplified syntax, you can use the <> `:` operator instead of `MATCH`. @@ -152,12 +155,7 @@ public class Match extends FullTextFunction implements OptionalArgument, PostAna `MATCH` returns true if the provided query matches the row.""", examples = { @Example(file = "match-function", tag = "match-with-field"), - @Example(file = "match-function", tag = "match-with-named-function-params") }, - appliesTo = { - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.COMING, - description = "Support for optional named parameters is only available in serverless, or in a future {{es}} release" - ) } + @Example(file = "match-function", tag = "match-with-named-function-params") } ) public Match( Source source, @@ -173,6 +171,7 @@ public Match( ) Expression matchQuery, @MapParam( name = "options", + description = "(Optional) Match additional options as <>.", params = { @MapParam.MapParamEntry( name = "analyzer", @@ -258,8 +257,6 @@ public Match( description = "Indicates whether all documents or none are returned if the analyzer removes all tokens, such as " + "when using a stop filter. Defaults to none." ) }, - description = "(Optional) Match additional options as <>." - + " See <> for more information.", optional = true ) Expression options ) { diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperator.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperator.java index 535eb15d29038..fb678037d2244 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperator.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperator.java @@ -12,6 +12,8 @@ import org.elasticsearch.xpack.esql.core.tree.NodeInfo; import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -29,6 +31,8 @@ public class MatchOperator extends Match { returnType = "boolean", operator = ":", preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.0.0") }, + // @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") }, description = """ Use the match operator (`:`) to perform a <> on the specified field. Using `:` is equivalent to using the `match` query in the Elasticsearch Query DSL. diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java index a068f28dfd716..5951538bfd919 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java @@ -93,11 +93,12 @@ public class MatchPhrase extends FullTextFunction implements OptionalArgument, P @FunctionInfo( returnType = "boolean", preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.1.0") }, description = """ Use `MATCH_PHRASE` to perform a [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) on the specified field. - Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL. - + Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.""", + detailedDescription = """ MatchPhrase can be used on <> fields, as well as other field types like keyword, boolean, or date types. MatchPhrase is not supported for <> or numeric types. @@ -106,12 +107,7 @@ public class MatchPhrase extends FullTextFunction implements OptionalArgument, P All [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) query parameters are supported. `MATCH_PHRASE` returns true if the provided query matches the row.""", - examples = { @Example(file = "match-phrase-function", tag = "match-phrase-with-field") }, - appliesTo = { - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.COMING, - description = "Support for optional named parameters is only available in serverless, or in a future {{es}} release" - ) } + examples = { @Example(file = "match-phrase-function", tag = "match-phrase-with-field", applies_to = "stack: ga 9.1.0") } ) public MatchPhrase( Source source, diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java index 4b5a7547d3203..b7fd5ae53a150 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java @@ -105,17 +105,15 @@ public class QueryString extends FullTextFunction implements OptionalArgument { @FunctionInfo( returnType = "boolean", preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.0.0") }, + // @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") }, description = "Performs a <>. " + "Returns true if the provided query string matches the row.", examples = { @Example(file = "qstr-function", tag = "qstr-with-field"), - @Example(file = "qstr-function", tag = "qstr-with-options") }, - appliesTo = { - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.COMING, - description = "Support for optional named parameters is only available in serverless, or in a future {{es}} release" - ) } + @Example(file = "qstr-function", tag = "qstr-with-options", applies_to = "stack: ga 9.1.0") } ) + public QueryString( Source source, @Param( diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Term.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Term.java index 606c6fe1c1159..94de3d33251d8 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Term.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Term.java @@ -23,6 +23,8 @@ import org.elasticsearch.xpack.esql.core.tree.NodeInfo; import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.io.stream.PlanStreamInput; @@ -50,6 +52,7 @@ public class Term extends FullTextFunction implements PostAnalysisPlanVerificati @FunctionInfo( returnType = "boolean", preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Performs a Term query on the specified field. Returns true if the provided term matches the row.", examples = { @Example(file = "term-function", tag = "term-with-field") } ) diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/convert/ToUnsignedLong.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/convert/ToUnsignedLong.java index 3c2005fd0bbf7..524f95561ff17 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/convert/ToUnsignedLong.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/convert/ToUnsignedLong.java @@ -17,6 +17,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -58,6 +60,8 @@ public class ToUnsignedLong extends AbstractConvertFunction { @FunctionInfo( returnType = "unsigned_long", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = """ Converts an input value to an unsigned long value. If the input parameter is of a date type, its value will be interpreted as milliseconds since the {wikipedia}/Unix_time[Unix epoch], converted to unsigned long. diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/math/RoundTo.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/math/RoundTo.java index adf8ab7ce0401..ef1ac8337bc59 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/math/RoundTo.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/math/RoundTo.java @@ -57,7 +57,7 @@ public class RoundTo extends EsqlScalarFunction { description = """ Rounds down to one of a list of fixed points.""", examples = @Example(file = "math", tag = "round_to"), - appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.COMING, version = "8.19.0/9.1.0") } + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.1.0") } ) public RoundTo( Source source, diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StEnvelope.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StEnvelope.java index 40167c48ce6c1..6cbcb6a5af048 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StEnvelope.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StEnvelope.java @@ -21,6 +21,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.UnaryScalarFunction; @@ -51,6 +53,8 @@ public class StEnvelope extends UnaryScalarFunction { @FunctionInfo( returnType = { "geo_shape", "cartesian_shape" }, + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Determines the minimum bounding box of the supplied geometry.", examples = @Example(file = "spatial_shapes", tag = "st_envelope") ) diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohash.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohash.java index 6fcef627e2cbc..b4a302824c924 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohash.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohash.java @@ -26,6 +26,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -100,6 +102,8 @@ private static int checkPrecisionRange(int precision) { @FunctionInfo( returnType = "long", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = """ Calculates the `geohash` of the supplied geo_point at the specified precision. The result is long encoded. Use [ST_GEOHASH_TO_STRING](#esql-st_geohash_to_string) to convert the result to a string. diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToLong.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToLong.java index 717dfea9724ec..5b2a4fdb2175c 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToLong.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToLong.java @@ -18,6 +18,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.convert.AbstractConvertFunction; @@ -43,6 +45,8 @@ public class StGeohashToLong extends AbstractConvertFunction implements Evaluato @FunctionInfo( returnType = "long", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Converts an input value representing a geohash grid-ID in string format into a long.", examples = { @Example(file = "spatial-grid", tag = "geohash_to_long") }, depthOffset = 1 // make it appear as a subsection of ST_GEOHASH diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToString.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToString.java index d3c6f7697e0c9..fa3362b28b1df 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToString.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohashToString.java @@ -18,6 +18,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.convert.AbstractConvertFunction; @@ -43,6 +45,8 @@ public class StGeohashToString extends AbstractConvertFunction implements Evalua @FunctionInfo( returnType = "keyword", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Converts an input value representing a geohash grid-ID in long format into a string.", examples = { @Example(file = "spatial-grid", tag = "geohash_to_string") }, depthOffset = 1 // make it appear as a subsection of ST_GEOHASH diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohex.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohex.java index cbbd9cf362e5b..23ca277f4b3b6 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohex.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohex.java @@ -27,6 +27,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -98,6 +100,8 @@ private static int checkPrecisionRange(int precision) { @FunctionInfo( returnType = "long", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = """ Calculates the `geohex`, the H3 cell-id, of the supplied geo_point at the specified precision. The result is long encoded. Use [ST_GEOHEX_TO_STRING](#esql-st_geohex_to_string) to convert the result to a string. diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToLong.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToLong.java index abb357a683109..4be2f51659a90 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToLong.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToLong.java @@ -18,6 +18,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.convert.AbstractConvertFunction; @@ -43,6 +45,8 @@ public class StGeohexToLong extends AbstractConvertFunction implements Evaluator @FunctionInfo( returnType = "long", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Converts an input value representing a geohex grid-ID in string format into a long.", examples = { @Example(file = "spatial-grid", tag = "geohex_to_long") }, depthOffset = 1 // make it appear as a subsection of ST_GEOHEX diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToString.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToString.java index 9632fe983a66b..d82dc3f61dbf2 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToString.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeohexToString.java @@ -18,6 +18,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.convert.AbstractConvertFunction; @@ -43,6 +45,8 @@ public class StGeohexToString extends AbstractConvertFunction implements Evaluat @FunctionInfo( returnType = "keyword", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Converts an input value representing a Geohex grid-ID in long format into a string.", examples = { @Example(file = "spatial-grid", tag = "geohex_to_string") }, depthOffset = 1 // make it appear as a subsection of ST_GEOHEX diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotile.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotile.java index 66e2bbe2e3358..81b4e676ceafd 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotile.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotile.java @@ -26,6 +26,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; @@ -94,6 +96,8 @@ public String toString() { @FunctionInfo( returnType = "long", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = """ Calculates the `geotile` of the supplied geo_point at the specified precision. The result is long encoded. Use [ST_GEOTILE_TO_STRING](#esql-st_geotile_to_string) to convert the result to a string. diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToLong.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToLong.java index fd52f273a4f76..64950c77e56aa 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToLong.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToLong.java @@ -18,6 +18,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.convert.AbstractConvertFunction; @@ -43,6 +45,8 @@ public class StGeotileToLong extends AbstractConvertFunction implements Evaluato @FunctionInfo( returnType = "long", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Converts an input value representing a geotile grid-ID in string format into a long.", examples = { @Example(file = "spatial-grid", tag = "geotile_to_long") }, depthOffset = 1 // make it appear as a subsection of ST_GEOTILE diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToString.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToString.java index 1a2d2b88afc52..115ebbe270a3a 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToString.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StGeotileToString.java @@ -18,6 +18,8 @@ import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.convert.AbstractConvertFunction; @@ -43,6 +45,8 @@ public class StGeotileToString extends AbstractConvertFunction implements Evalua @FunctionInfo( returnType = "keyword", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Converts an input value representing a geotile grid-ID in long format into a string.", examples = { @Example(file = "spatial-grid", tag = "geotile_to_string") }, depthOffset = 1 // make it appear as a subsection of ST_GEOTILE diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMax.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMax.java index ad40756eae2f7..2b719dd26403d 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMax.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMax.java @@ -21,6 +21,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.UnaryScalarFunction; @@ -43,6 +45,8 @@ public class StXMax extends UnaryScalarFunction { @FunctionInfo( returnType = "double", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Extracts the maximum value of the `x` coordinates from the supplied geometry.\n" + "If the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the maximum `longitude` value.", examples = @Example(file = "spatial_shapes", tag = "st_x_y_min_max"), diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMin.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMin.java index 9774c4b0f1899..b344badcf8619 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMin.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StXMin.java @@ -21,6 +21,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.UnaryScalarFunction; @@ -43,6 +45,8 @@ public class StXMin extends UnaryScalarFunction { @FunctionInfo( returnType = "double", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Extracts the minimum value of the `x` coordinates from the supplied geometry.\n" + "If the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the minimum `longitude` value.", examples = @Example(file = "spatial_shapes", tag = "st_x_y_min_max"), diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMax.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMax.java index c852d1f9c169a..1ea73c576483a 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMax.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMax.java @@ -21,6 +21,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.UnaryScalarFunction; @@ -43,6 +45,8 @@ public class StYMax extends UnaryScalarFunction { @FunctionInfo( returnType = "double", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Extracts the maximum value of the `y` coordinates from the supplied geometry.\n" + "If the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the maximum `latitude` value.", examples = @Example(file = "spatial_shapes", tag = "st_x_y_min_max"), diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMin.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMin.java index 2285a92ccaaf8..68f64ee6cad32 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMin.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/spatial/StYMin.java @@ -21,6 +21,8 @@ import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.core.type.DataType; import org.elasticsearch.xpack.esql.expression.function.Example; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; +import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.expression.function.scalar.UnaryScalarFunction; @@ -43,6 +45,8 @@ public class StYMin extends UnaryScalarFunction { @FunctionInfo( returnType = "double", + preview = true, + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW) }, description = "Extracts the minimum value of the `y` coordinates from the supplied geometry.\n" + "If the geometry is of type `geo_point` or `geo_shape` this is equivalent to extracting the minimum `latitude` value.", examples = @Example(file = "spatial_shapes", tag = "st_x_y_min_max"), diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToLower.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToLower.java index dcb6f637b3b03..7e65f33e4ab19 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToLower.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToLower.java @@ -15,8 +15,6 @@ import org.elasticsearch.xpack.esql.core.tree.NodeInfo; import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.expression.function.Example; -import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; -import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.io.stream.PlanStreamInput; @@ -30,17 +28,15 @@ public class ToLower extends ChangeCase { @FunctionInfo( returnType = { "keyword" }, description = "Returns a new string representing the input string converted to lower case.", - examples = { @Example(file = "string", tag = "to_lower"), @Example(file = "string", tag = "to_lower_mv"), }, - appliesTo = { - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.COMING, - version = "9.1.0", - description = "Support for multivalued parameters is only available from 9.1.0" - ) } + examples = { + @Example(file = "string", tag = "to_lower"), + @Example(file = "string", tag = "to_lower_mv", applies_to = "stack: ga 9.1.0") } ) + public ToLower(Source source, @Param(name = "str", type = { "keyword", "text" }, description = """ - String expression. If `null`, the function returns `null`. - The input can be a single- or multi-valued column or an expression.""") Expression field, Configuration configuration) { + String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, + or a multi-valued column or expression {applies_to}`stack: ga 9.1.0`. + """) Expression field, Configuration configuration) { super(source, field, configuration, Case.LOWER); } diff --git a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToUpper.java b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToUpper.java index 14691c80498e2..824fb5457d31e 100644 --- a/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToUpper.java +++ b/x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/string/ToUpper.java @@ -15,8 +15,6 @@ import org.elasticsearch.xpack.esql.core.tree.NodeInfo; import org.elasticsearch.xpack.esql.core.tree.Source; import org.elasticsearch.xpack.esql.expression.function.Example; -import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesTo; -import org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle; import org.elasticsearch.xpack.esql.expression.function.FunctionInfo; import org.elasticsearch.xpack.esql.expression.function.Param; import org.elasticsearch.xpack.esql.io.stream.PlanStreamInput; @@ -30,17 +28,12 @@ public class ToUpper extends ChangeCase { @FunctionInfo( returnType = { "keyword" }, description = "Returns a new string representing the input string converted to upper case.", - examples = @Example(file = "string", tag = "to_upper"), - appliesTo = { - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.COMING, - version = "9.1.0", - description = "Support for multivalued parameters is only available from 9.1.0" - ) } + examples = @Example(file = "string", tag = "to_upper") ) public ToUpper(Source source, @Param(name = "str", type = { "keyword", "text" }, description = """ - String expression. If `null`, the function returns `null`. - The input can be a single- or multi-valued column or an expression.""") Expression field, Configuration configuration) { + String expression. If `null`, the function returns `null`. The input can be a single-valued column or expression, + or a multi-valued column or expression {applies_to}`stack: ga 9.1.0`. + """) Expression field, Configuration configuration) { super(source, field, configuration, Case.UPPER); } diff --git a/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java b/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java index 788f7edbe6ec5..7bcb194c62a75 100644 --- a/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java +++ b/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3Support.java @@ -75,7 +75,6 @@ import static org.elasticsearch.xpack.esql.expression.function.EsqlFunctionRegistry.mapParam; import static org.elasticsearch.xpack.esql.expression.function.EsqlFunctionRegistry.param; import static org.elasticsearch.xpack.esql.expression.function.EsqlFunctionRegistry.paramWithoutAnnotation; -import static org.elasticsearch.xpack.esql.expression.function.FunctionAppliesToLifecycle.GA; /** * This class exists to support the new Docs V3 system. @@ -99,12 +98,6 @@ public abstract class DocsV3Support { protected static final String DOCS_WARNING = "% " + DOCS_WARNING_JSON + "\n\n"; - static final String PREVIEW_CALLOUT = """ - Do not use on production environments. This functionality is in technical preview and - may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview - are not subject to the support SLA of official GA features. - """; - static FunctionDocsSupport forFunctions(String name, Class testClass) { return new FunctionDocsSupport(name, testClass); } @@ -599,73 +592,35 @@ private void renderFunctionNamedParams(EsqlFunctionRegistry.MapArgSignature mapA writeToTempSnippetsDir("functionNamedParams", rendered.toString()); } - private String makeCallout(String type, String text) { - return ":::{" + type + "}\n" + text.trim() + "\n:::\n"; - } - - private String makePreviewText(boolean preview, FunctionAppliesTo[] functionAppliesTos) { - String appliesToTextWithAT = appliesToText(functionAppliesTos); - String appliesToText = appliesToTextWithoutAppliesTo(functionAppliesTos); - StringBuilder previewText = new StringBuilder(); - if (preview) { - // We have a preview flag, use the WARNING callout - previewText.append(makeCallout("warning", "\n" + PREVIEW_CALLOUT + "\n")).append("\n"); - } - if (appliesToTextWithAT.isEmpty() == false) { - // No additional text, just use the plan applies_to syntax - previewText.append(appliesToTextWithAT); - } else if (appliesToText.isEmpty() == false) { - // We have extra descriptive text, nest inside a NOTE for emphasis - previewText.append(makeCallout("note", appliesToText)); - } - return previewText.toString(); - } - - private String appliesToText(FunctionAppliesTo[] functionAppliesTos) { + private String makeAppliesToText(FunctionAppliesTo[] functionAppliesTos, boolean preview) { StringBuilder appliesToText = new StringBuilder(); if (functionAppliesTos.length > 0) { appliesToText.append("```{applies_to}\n"); + StringBuilder stackEntries = new StringBuilder(); + for (FunctionAppliesTo appliesTo : functionAppliesTos) { - if (appliesTo.description().isEmpty() == false) { - // If any of the appliesTo has descriptive text, we need to format things differently - return ""; + if (stackEntries.isEmpty() == false) { + stackEntries.append(", "); } - appliesToText.append("product: "); - appendLifeCycleAndVersion(appliesToText, appliesTo); - appliesToText.append("\n"); - if (appliesTo.serverless() && appliesTo.lifeCycle().serverlessLifecycle() == GA) { - appliesToText.append("serverless: ").append(GA).append("\n"); + stackEntries.append(appliesTo.lifeCycle().name().toLowerCase(Locale.ROOT)); + if (appliesTo.version().isEmpty() == false) { + stackEntries.append(" ").append(appliesTo.version()); } } - appliesToText.append("```\n"); - } - return appliesToText.toString(); - } - private String appliesToTextWithoutAppliesTo(FunctionAppliesTo[] functionAppliesTos) { - StringBuilder appliesToText = new StringBuilder(); - if (functionAppliesTos.length > 0) { - appliesToText.append("\n"); - for (FunctionAppliesTo appliesTo : functionAppliesTos) { - appliesToText.append("###### "); - if (appliesTo.serverless() && appliesTo.lifeCycle().serverlessLifecycle() == GA) { - appliesToText.append("Serverless: ").append(GA).append(", Elastic Stack: "); - } - appendLifeCycleAndVersion(appliesToText, appliesTo); - appliesToText.append("\n"); - if (appliesTo.description().isEmpty() == false) { - appliesToText.append(appliesTo.description()).append("\n\n"); - } + // Add the stack entries + if (stackEntries.isEmpty() == false) { + appliesToText.append("stack: ").append(stackEntries).append("\n"); } - } - return appliesToText.toString(); - } - private void appendLifeCycleAndVersion(StringBuilder appliesToText, FunctionAppliesTo appliesTo) { - appliesToText.append(appliesTo.lifeCycle().name()); - if (appliesTo.version().isEmpty() == false) { - appliesToText.append(" ").append(appliesTo.version()); + // Only specify serverless if it's preview, using the preview boolean (GA is the default) + if (preview) { + appliesToText.append("serverless: preview\n"); + } + + appliesToText.append("```\n"); } + return appliesToText.toString(); } private void renderFullLayout(FunctionInfo info, boolean hasExamples, boolean hasAppendix, boolean hasFunctionOptions) @@ -674,7 +629,7 @@ private void renderFullLayout(FunctionInfo info, boolean hasExamples, boolean ha StringBuilder rendered = new StringBuilder( DOCS_WARNING + """ $HEAD$ `$UPPER_NAME$` [esql-$NAME$] - $PREVIEW_CALLOUT$ + $APPLIES_TO$ **Syntax** :::{image} ../../../images/$CATEGORY$/$NAME$.svg @@ -686,7 +641,7 @@ private void renderFullLayout(FunctionInfo info, boolean hasExamples, boolean ha .replace("$NAME$", name) .replace("$CATEGORY$", category) .replace("$UPPER_NAME$", name.toUpperCase(Locale.ROOT)) - .replace("$PREVIEW_CALLOUT$", makePreviewText(info.preview(), info.appliesTo())) + .replace("$APPLIES_TO$", makeAppliesToText(info.appliesTo(), info.preview())) ); for (String section : new String[] { "parameters", "description", "types" }) { rendered.append(addInclude(section)); @@ -1027,6 +982,11 @@ protected boolean renderExamples(FunctionInfo info) throws IOException { builder.append("**Examples**\n\n"); } for (Example example : info.examples()) { + if (example.applies_to().isEmpty() == false) { + builder.append("```{applies_to}\n"); + builder.append(example.applies_to()).append("\n"); + builder.append("```\n\n"); + } if (example.description().isEmpty() == false) { builder.append(replaceLinks(example.description().trim())); builder.append("\n\n"); @@ -1059,7 +1019,9 @@ void renderKibanaInlineDocs(String name, String titleName, FunctionInfo info) th StringBuilder builder = new StringBuilder(); builder.append(DOCS_WARNING); builder.append("### ").append(titleName.toUpperCase(Locale.ROOT)).append("\n"); - builder.append(replaceLinks(info.description())).append("\n\n"); + String cleanedDesc = replaceLinks(info.description()); + cleanedDesc = removeAppliesToBlocks(cleanedDesc); + builder.append(cleanedDesc).append("\n\n"); if (info.examples().length > 0) { Example example = info.examples()[0]; @@ -1068,7 +1030,9 @@ void renderKibanaInlineDocs(String name, String titleName, FunctionInfo info) th builder.append("\n```\n"); } if (Strings.isNullOrEmpty(info.note()) == false) { - builder.append("Note: ").append(replaceLinks(info.note())).append("\n"); + String cleanedNote = replaceLinks(info.note()); + cleanedNote = removeAppliesToBlocks(cleanedNote); + builder.append("Note: ").append(cleanedNote).append("\n"); } String rendered = builder.toString(); logger.info("Writing kibana inline docs for [{}]:\n{}", name, rendered); @@ -1105,9 +1069,13 @@ void renderKibanaFunctionDefinition( if (titleName != null && titleName.equals(name) == false) { builder.field("titleName", titleName); } - builder.field("description", removeAsciidocLinks(info.description())); + String cleanedDescription = removeAsciidocLinks(info.description()); + cleanedDescription = removeAppliesToBlocks(cleanedDescription); + builder.field("description", cleanedDescription); if (Strings.isNullOrEmpty(info.note()) == false) { - builder.field("note", removeAsciidocLinks(info.note())); + String cleanedNote = removeAsciidocLinks(info.note()); + cleanedNote = removeAppliesToBlocks(cleanedNote); + builder.field("note", cleanedNote); } // TODO aliases @@ -1152,7 +1120,8 @@ void renderKibanaFunctionDefinition( builder.field("type", sig.getKey().get(i).esNameIfPossible()); } builder.field("optional", arg.optional()); - builder.field("description", arg.description()); + String cleanedParamDesc = removeAppliesToBlocks(arg.description()); + builder.field("description", cleanedParamDesc); builder.endObject(); } builder.endArray(); @@ -1190,6 +1159,20 @@ private String removeAsciidocLinks(String asciidoc) { return md.replaceAll("\\[(\\s*`?[^]]+?`?\\s*)]\\(([^()\\s]+(?:\\([^()]*\\)[^()]*)*)\\)", "$1"); } + /** + * Removes applies_to blocks from content intended for Kibana consumption. + * Applies_to syntax like {applies_to}`stack: ga 9.1.0` should not appear in Kibana JSON files. + */ + private static String removeAppliesToBlocks(String content) { + if (content == null) { + return null; + } + + // Remove {applies_to}`...` blocks using regex + // Matches: {applies_to}`anything` including backticks and content inside + return content.replaceAll("\\s*\\{applies_to\\}`[^`]*`\\s*", ""); + } + private List, DataType>> sortedSignatures() { List, DataType>> sortedSignatures = new ArrayList<>(signatures.get().entrySet()); sortedSignatures.sort((lhs, rhs) -> { diff --git a/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3SupportTests.java b/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3SupportTests.java index 211607a5a8714..26646c9a30b7e 100644 --- a/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3SupportTests.java +++ b/x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/DocsV3SupportTests.java @@ -274,7 +274,7 @@ public void testRenderingExampleFromClass() throws Exception { To count the number of times an expression returns `TRUE` use a [`WHERE`](/reference/query-languages/esql/commands/processing-commands.md#esql-where) command - to remove rows that shouldn’t be included + to remove rows that shouldn't be included ```esql ROW n=1 @@ -311,22 +311,9 @@ public void testRenderingLayoutFromClass() throws Exception { % This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it. ## `COUNT` [esql-count] - :::{warning} - Do not use on production environments. This functionality is in technical preview and - may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview - are not subject to the support SLA of official GA features. - ::: - - :::{note} - ###### Serverless: GA, Elastic Stack: COMING 9.1.0 - Support for optional named parameters is only available from 9.1.0 - - ###### DEVELOPMENT - The ability to generate more imaginative answers to the question is under development - - ###### DISCONTINUED 9.0.0 - The ability to count the number of emojis in a string has been discontinued since 9.0.0 - ::: + ```{applies_to} + stack: ga 9.1.0 + ``` **Syntax** @@ -406,7 +393,6 @@ private static Constructor constructorFor(Class clazz) { public static class TestClass extends Function { @FunctionInfo( returnType = "long", - preview = true, description = "Returns the total number (count) of input values.", type = FunctionType.AGGREGATE, examples = { @@ -418,7 +404,7 @@ public static class TestClass extends Function { @Example(description = """ To count the number of times an expression returns `TRUE` use a <> command - to remove rows that shouldn’t be included""", file = "stats", tag = "count-where"), + to remove rows that shouldn't be included""", file = "stats", tag = "count-where"), @Example( description = """ To count the same stream of data based on two different expressions use the pattern @@ -429,21 +415,7 @@ public static class TestClass extends Function { file = "stats", tag = "count-or-null" ) }, - appliesTo = { - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.COMING, - version = "9.1.0", - description = "Support for optional named parameters is only available from 9.1.0" - ), - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.DEVELOPMENT, - description = "The ability to generate more imaginative answers to the question is under development" - ), - @FunctionAppliesTo( - lifeCycle = FunctionAppliesToLifecycle.DISCONTINUED, - version = "9.0.0", - description = "The ability to count the number of emojis in a string has been discontinued since 9.0.0" - ) } + appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") } ) public TestClass(Source source, @Param(name = "str", type = { "keyword", "text" }, description = """ String expression. If `null`, the function returns `null`.