Skip to content

Commit 5a03f5d

Browse files
committed
use detailedDescription + and fix match_phrase applies_to syntax
1 parent f1c2a36 commit 5a03f5d

File tree

9 files changed

+34
-44
lines changed

9 files changed

+34
-44
lines changed

docs/reference/query-languages/esql/_snippets/functions/description/match.md

Lines changed: 13 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/description/match_phrase.md

Lines changed: 10 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/match_phrase.md

Lines changed: 4 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/definition/functions/match.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/definition/functions/match_phrase.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/docs/functions/match.md

Lines changed: 0 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/docs/functions/match_phrase.md

Lines changed: 0 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ public class Match extends FullTextFunction implements OptionalArgument, PostAna
140140
@FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.GA, version = "9.1.0") },
141141
description = """
142142
Use `MATCH` to perform a <<query-dsl-match-query,match query>> on the specified field.
143-
Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.
144-
143+
Using `MATCH` is equivalent to using the `match` query in the Elasticsearch Query DSL.""",
144+
detailedDescription = """
145145
Match can be used on fields from the text family like <<text, text>> and <<semantic-text, semantic_text>>,
146146
as well as other field types like keyword, boolean, dates, and numeric types.
147147
When Match is used on a <<semantic-text, semantic_text>> field, it will perform a semantic query on the field.

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

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ public class MatchPhrase extends FullTextFunction implements OptionalArgument, P
9696
description = """
9797
Use `MATCH_PHRASE` to perform a [`match_phrase`](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) on the
9898
specified field.
99-
Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.
100-
99+
Using `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.""",
100+
detailedDescription = """
101101
MatchPhrase can be used on <<text, text>> fields, as well as other field types like keyword, boolean, or date types.
102102
MatchPhrase is not supported for <<semantic-text, semantic_text>> or numeric types.
103103
@@ -107,11 +107,7 @@ public class MatchPhrase extends FullTextFunction implements OptionalArgument, P
107107
108108
`MATCH_PHRASE` returns true if the provided query matches the row.""",
109109
examples = { @Example(file = "match-phrase-function", tag = "match-phrase-with-field") },
110-
appliesTo = {
111-
@FunctionAppliesTo(
112-
lifeCycle = FunctionAppliesToLifecycle.COMING,
113-
description = "Support for optional named parameters is only available in serverless, or in a future {{es}} release"
114-
) }
110+
appliesTo = { @FunctionAppliesTo(lifeCycle = FunctionAppliesToLifecycle.PREVIEW, version = "9.1.0"), }
115111
)
116112
public MatchPhrase(
117113
Source source,

0 commit comments

Comments
 (0)