Browse Source

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

Promote ESQL search functions to GA in the docs

- removed `preview = true` from java function annotations for full-text search functions
- generated updates to asciidoc and kibana docs
- 8.x equivalent of https://github.com/elastic/elasticsearch/pull/129786
Liam Thompson 3 months ago
parent
commit
c19cc6ba92
20 changed files with 18 additions and 32 deletions
  1. 1 2
      docs/reference/esql/esql-limitations.asciidoc
  2. 1 1
      docs/reference/esql/functions/description/match_phrase.asciidoc
  3. 1 1
      docs/reference/esql/functions/kibana/definition/kql.json
  4. 1 1
      docs/reference/esql/functions/kibana/definition/match.json
  5. 1 1
      docs/reference/esql/functions/kibana/definition/match_operator.json
  6. 2 2
      docs/reference/esql/functions/kibana/definition/match_phrase.json
  7. 1 1
      docs/reference/esql/functions/kibana/definition/qstr.json
  8. 2 2
      docs/reference/esql/functions/kibana/docs/match_phrase.md
  9. 0 2
      docs/reference/esql/functions/layout/kql.asciidoc
  10. 0 2
      docs/reference/esql/functions/layout/match.asciidoc
  11. 0 2
      docs/reference/esql/functions/layout/match_phrase.asciidoc
  12. 0 2
      docs/reference/esql/functions/layout/qstr.asciidoc
  13. 1 1
      docs/reference/esql/functions/operators.asciidoc
  14. 5 3
      docs/reference/esql/functions/search-functions.asciidoc
  15. 0 2
      docs/reference/esql/functions/search.asciidoc
  16. 0 1
      x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Kql.java
  17. 0 1
      x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java
  18. 0 1
      x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperator.java
  19. 2 3
      x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java
  20. 0 1
      x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java

+ 1 - 2
docs/reference/esql/esql-limitations.asciidoc

@@ -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.

+ 1 - 1
docs/reference/esql/functions/description/match_phrase.asciidoc

@@ -2,4 +2,4 @@
 
 *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, text>> fields, as well as other field types like keyword, boolean, or date types. MatchPhrase is not supported for <<semantic-text, semantic_text>> or numeric types.  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.  `MATCH_PHRASE` returns true if the provided query matches the row.
+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.  MatchPhrase can be used on <<text, text>> fields, as well as other field types like keyword, boolean, or date types. MatchPhrase is not supported for <<semantic-text, semantic_text>> or numeric types.  MatchPhrase can use <<esql-function-named-params,function named parameters>> to specify additional options for the match_phrase query. All <<query-dsl-match-query-phrase,`match_phrase` query>> query parameters are supported.  `MATCH_PHRASE` returns true if the provided query matches the row.

+ 1 - 1
docs/reference/esql/functions/kibana/definition/kql.json

@@ -32,6 +32,6 @@
   "examples" : [
     "FROM books \n| WHERE KQL(\"author: Faulkner\")\n| KEEP book_no, author \n| SORT book_no "
   ],
-  "preview" : true,
+  "preview" : false,
   "snapshot_only" : false
 }

+ 1 - 1
docs/reference/esql/functions/kibana/definition/match.json

@@ -734,6 +734,6 @@
     "FROM books \n| WHERE MATCH(author, \"Faulkner\")",
     "FROM books \n| WHERE MATCH(title, \"Hobbit Back Again\", {\"operator\": \"AND\"})\n| KEEP title;"
   ],
-  "preview" : true,
+  "preview" : false,
   "snapshot_only" : false
 }

+ 1 - 1
docs/reference/esql/functions/kibana/definition/match_operator.json

@@ -531,6 +531,6 @@
   "examples" : [
     "FROM books \n| WHERE MATCH(author, \"Faulkner\")"
   ],
-  "preview" : true,
+  "preview" : false,
   "snapshot_only" : false
 }

+ 2 - 2
docs/reference/esql/functions/kibana/definition/match_phrase.json

@@ -2,7 +2,7 @@
   "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.",
   "type" : "eval",
   "name" : "match_phrase",
-  "description" : "Use `MATCH_PHRASE` to perform a [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) 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, text>> fields, as well as other field types like keyword, boolean, or date types.\nMatchPhrase is not supported for <<semantic-text, semantic_text>> or numeric types.\n\nMatchPhrase can use <<esql-function-named-params,function named parameters>> to specify additional options for the\nmatch_phrase query.\nAll [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) query parameters are supported.\n\n`MATCH_PHRASE` returns true if the provided query matches the row.",
+  "description" : "Use `MATCH_PHRASE` to perform a <<query-dsl-match-query-phrase,`match_phrase` query>> 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, text>> fields, as well as other field types like keyword, boolean, or date types.\nMatchPhrase is not supported for <<semantic-text, semantic_text>> or numeric types.\n\nMatchPhrase can use <<esql-function-named-params,function named parameters>> to specify additional options for the\nmatch_phrase query.\nAll <<query-dsl-match-query-phrase,`match_phrase` query>> query parameters are supported.\n\n`MATCH_PHRASE` returns true if the provided query matches the row.",
   "signatures" : [
     {
       "params" : [
@@ -58,6 +58,6 @@
   "examples" : [
     "FROM books\n| WHERE MATCH_PHRASE(author, \"William Faulkner\")"
   ],
-  "preview" : true,
+  "preview" : false,
   "snapshot_only" : false
 }

+ 1 - 1
docs/reference/esql/functions/kibana/definition/qstr.json

@@ -47,6 +47,6 @@
     "FROM books \n| WHERE QSTR(\"author: Faulkner\")",
     "FROM books \n| WHERE QSTR(\"title: Hobbjt~\", {\"fuzziness\": 2})"
   ],
-  "preview" : true,
+  "preview" : false,
   "snapshot_only" : false
 }

+ 2 - 2
docs/reference/esql/functions/kibana/docs/match_phrase.md

@@ -3,7 +3,7 @@ This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../READ
 -->
 
 ### MATCH_PHRASE
-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.
 
@@ -12,7 +12,7 @@ MatchPhrase is not supported for <<semantic-text, semantic_text>> or numeric typ
 
 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.
 

+ 0 - 2
docs/reference/esql/functions/layout/kql.asciidoc

@@ -4,8 +4,6 @@
 [[esql-kql]]
 === `KQL`
 
-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."]
-
 *Syntax*
 
 [.text-center]

+ 0 - 2
docs/reference/esql/functions/layout/match.asciidoc

@@ -4,8 +4,6 @@
 [[esql-match]]
 === `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."]
-
 *Syntax*
 
 [.text-center]

+ 0 - 2
docs/reference/esql/functions/layout/match_phrase.asciidoc

@@ -4,8 +4,6 @@
 [[esql-match_phrase]]
 === `MATCH_PHRASE`
 
-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."]
-
 *Syntax*
 
 [.text-center]

+ 0 - 2
docs/reference/esql/functions/layout/qstr.asciidoc

@@ -4,8 +4,6 @@
 [[esql-qstr]]
 === `QSTR`
 
-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."]
-
 *Syntax*
 
 [.text-center]

+ 1 - 1
docs/reference/esql/functions/operators.asciidoc

@@ -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[]

+ 5 - 3
docs/reference/esql/functions/search-functions.asciidoc

@@ -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[]

+ 0 - 2
docs/reference/esql/functions/search.asciidoc

@@ -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.
 

+ 0 - 1
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Kql.java

@@ -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") }
     )

+ 0 - 1
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java

@@ -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.

+ 0 - 1
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchOperator.java

@@ -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.

+ 2 - 3
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/MatchPhrase.java

@@ -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.
 
@@ -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") }

+ 0 - 1
x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/QueryString.java

@@ -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 = {