Skip to content

[DOCS][8.19] Promote ESQL search functions to GA in the docs #129897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/reference/esql/esql-limitations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,7 @@ is currently experimental.
[[esql-limitations-full-text-search]]
=== Full-text search

experimental:[] {esql}'s support for <<esql-search-functions,full-text search>>
is currently in Technical Preview. One limitation of full-text search is that
One limitation of <<esql-search-functions,full-text search>> is that
it is necessary to use the search function, like <<esql-match>>, in a <<esql-where>> command
directly after the <<esql-from>> source command, or close enough to it.
Otherwise, the query will fail with a validation error.
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/esql/functions/kibana/definition/kql.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/esql/functions/kibana/definition/match.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/esql/functions/kibana/definition/qstr.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/reference/esql/functions/kibana/docs/match_phrase.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions docs/reference/esql/functions/layout/kql.asciidoc

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions docs/reference/esql/functions/layout/match.asciidoc

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions docs/reference/esql/functions/layout/match_phrase.asciidoc

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions docs/reference/esql/functions/layout/qstr.asciidoc

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/esql/functions/operators.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Boolean operators for comparing against one or multiple expressions.
* <<esql-in-operator>>
* <<esql-like-operator>>
* <<esql-rlike-operator>>
* experimental:[] <<esql-search-operators>>
* <<esql-search-operators>>
// end::op_list[]

include::binary.asciidoc[]
Expand Down
8 changes: 5 additions & 3 deletions docs/reference/esql/functions/search-functions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ See <<esql-limitations-full-text-search,full text search limitations>> for infor
{esql} supports these full-text search functions:

// tag::search_list[]
* experimental:[] <<esql-kql>>
* experimental:[] <<esql-match>>
* experimental:[] <<esql-qstr>>
* <<esql-kql>>
* <<esql-match>>
* <<esql-match_phrase>>
* <<esql-qstr>>
// end::search_list[]

include::layout/kql.asciidoc[]
include::layout/match.asciidoc[]
include::layout/match_phrase.asciidoc[]
include::layout/qstr.asciidoc[]
2 changes: 0 additions & 2 deletions docs/reference/esql/functions/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

The only search operator is match (`:`).

preview::["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."]

The match operator performs a <<query-dsl-match-query,match query>> on the specified field.
Returns true if the provided query matches the row.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ public class Kql extends FullTextFunction {

@FunctionInfo(
returnType = "boolean",
preview = true,
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") }
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,6 @@ public class Match extends FullTextFunction implements OptionalArgument, PostAna

@FunctionInfo(
returnType = "boolean",
preview = true,
description = """
Use `MATCH` to perform a <<query-dsl-match-query,match query>> on the specified field.
Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ public class MatchOperator extends Match {
@FunctionInfo(
returnType = "boolean",
operator = ":",
preview = true,
description = """
Use the match operator (`:`) to perform a <<query-dsl-match-query,match query>> on the specified field.
Using `:` is equivalent to using the `match` query in the Elasticsearch Query DSL.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,8 @@ public class MatchPhrase extends FullTextFunction implements OptionalArgument, P

@FunctionInfo(
returnType = "boolean",
preview = true,
description = """
Use `MATCH_PHRASE` to perform a [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) on the
Use `MATCH_PHRASE` to perform a <<query-dsl-match-query-phrase,`match_phrase` query>> on the
specified field.
Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.

Expand All @@ -101,7 +100,7 @@ public class MatchPhrase extends FullTextFunction implements OptionalArgument, P

MatchPhrase can use <<esql-function-named-params,function named parameters>> 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.
All <<query-dsl-match-query-phrase,`match_phrase` query>> 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") }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ public class QueryString extends FullTextFunction implements OptionalArgument {

@FunctionInfo(
returnType = "boolean",
preview = true,
description = "Performs a <<query-dsl-query-string-query,query string query>>. "
+ "Returns true if the provided query string matches the row.",
examples = {
Expand Down