Skip to content

Commit

Permalink
Regenerate docs, minor adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosdelest committed Dec 18, 2024
1 parent 58c1c70 commit 7279a50
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/reference/esql/functions/description/match.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/kibana/definition/match.json

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

9 changes: 8 additions & 1 deletion docs/reference/esql/functions/kibana/docs/match.md

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

17 changes: 15 additions & 2 deletions docs/reference/esql/processing-commands/where.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,22 @@ For a complete list of all functions, refer to <<esql-functions>>.

include::../functions/predicates.asciidoc[tag=body]

For matching text, you can use <<serch-functions,full text search functions>> like `MATCH`.
For matching text, you can use <<esql-search-functions,full text search functions>> like `MATCH`.

include::../functions/match.asciidoc[tag=body]
Use <<esql-match,`MATCH`>> to perform a <<query-dsl-match-query,match query>> on a specified field.

Match can be used on text fields, as well as other field types like boolean, dates, and numeric types.

[source.merge.styled,esql]
----
include::{esql-specs}/match-function.csv-spec[tag=match-with-field]
----
[%header.monospaced.styled,format=dsv,separator=|]
|===
include::{esql-specs}/match-function.csv-spec[tag=match-with-field-result]
|===

For a simplified syntax, you can use the <<esql-search-operators,match operator>> `:` instead of `MATCH`.

include::../functions/like.asciidoc[tag=body]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,9 @@ public class Match extends FullTextFunction implements Validatable {
Match can be used on text fields, as well as other field types like boolean, dates, and numeric types.
For a simplified syntax, you can use the <<esql-search-operators,match operator>> `:` operator instead of `MATCH`.
`MATCH` returns true if the provided query matches the row.
""", examples = { @Example(file = "match-function", tag = "match-with-field") }
`MATCH` returns true if the provided query matches the row.""",
examples = { @Example(file = "match-function", tag = "match-with-field") }
)
public Match(
Source source,
Expand Down

0 comments on commit 7279a50

Please sign in to comment.