ESQL - Update WHERE command docs with MATCH and full text functions examples #118987
+53
−8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carlosdelest
added
>docs
|
Documentation preview: |
|
@elasticmachine update branch |
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
ppf2
reviewed
Dec 18, 2024
|
|
||
| Full text functions can be used to match <<esql-multivalued-fields,multivalued fields>>. | ||
| A multivalued field that contains a value that matches a full text query is considered to match the query. | ||
|
|
||
| Full text functions are more performant for text search use cases than using pattern matching or regular expressions with `LIKE` or `RLIKE`. |
There was a problem hiding this comment.
How about:
Full text functions are significantly more performant for text search use cases on large data sets than using pattern matching or regular expressions with LIKE or RLIKE.
There was a problem hiding this comment.
Looks good! 69fee78
…h-match-examples' into docs/esql-update-where-with-match-examples
|
@elasticmachine update branch |
leemthompo
approved these changes
Dec 19, 2024
There was a problem hiding this comment.
Some mainly minor suggestions from me, thanks @carlosdelest!
| @@ -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", | |||
| "description" : "Performs a <<query-dsl-match-query,match query>> on the specified field. Returns true if the provided query matches the row.", | |||
| "description" : "Use `MATCH` to perform a <<query-dsl-match-query,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 text fields, as well as other field types like boolean, dates, and numeric types.\n\nFor a simplified syntax, you can use the <<esql-search-operators,match operator>> `:` operator instead of `MATCH`.\n\n`MATCH` returns true if the provided query matches the row.", | |||
There was a problem hiding this comment.
Suggested change
| "description" : "Use `MATCH` to perform a <<query-dsl-match-query,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 text fields, as well as other field types like boolean, dates, and numeric types.\n\nFor a simplified syntax, you can use the <<esql-search-operators,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.\n\nMatch can be used on text fields, as well as other field types like boolean, dates, and numeric types.\n\nFor a simplified syntax, you can use the match operator `:` instead of `MATCH`.\n\n`MATCH` returns true if the provided query matches the row.", |
There was a problem hiding this comment.
edit to use plain markdown for Kibana inline docs
Co-authored-by: Liam Thompson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds some examples to WHERE command for full text functions, so users are aware of them for full text filtering.