Skip to content

Commit

Permalink
[8.x] [ES|QL] Update function metadata (#209231) (#209273)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.x`:
- [[ES|QL] Update function metadata
(#209231)](#209231)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Kibana
Machine","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-02-03T12:21:36Z","message":"[ES|QL]
Update function metadata (#209231)\n\nThis PR updates the function
definitions and inline docs based on the\nlatest metadata from
Elasticsearch.\n\n---------\n\nCo-authored-by: Stratoula Kalafateli
<[email protected]>","sha":"c1104ac6811b835d2d0a9988d28d7d1b5988dab7","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Feature:ES|QL","Team:ESQL","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"[ES|QL]
Update function
metadata","number":209231,"url":"https://github.com/elastic/kibana/pull/209231","mergeCommit":{"message":"[ES|QL]
Update function metadata (#209231)\n\nThis PR updates the function
definitions and inline docs based on the\nlatest metadata from
Elasticsearch.\n\n---------\n\nCo-authored-by: Stratoula Kalafateli
<[email protected]>","sha":"c1104ac6811b835d2d0a9988d28d7d1b5988dab7"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.x"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/209231","number":209231,"mergeCommit":{"message":"[ES|QL]
Update function metadata (#209231)\n\nThis PR updates the function
definitions and inline docs based on the\nlatest metadata from
Elasticsearch.\n\n---------\n\nCo-authored-by: Stratoula Kalafateli
<[email protected]>","sha":"c1104ac6811b835d2d0a9988d28d7d1b5988dab7"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
  • Loading branch information
kibanamachine authored Feb 3, 2025
1 parent f14bc5e commit 632cec7
Show file tree
Hide file tree
Showing 4 changed files with 273 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1384,6 +1384,9 @@ export const functions = {
Match can be used on fields from the text family like text and semantic_text,
as well as other field types like keyword, boolean, dates, and numeric types.
Match can use function named parameters to specify additional options for the match query.
All match query parameters are supported.
For a simplified syntax, you can use the match operator \`:\` operator instead of \`MATCH\`.
\`MATCH\` returns true if the provided query matches the row.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2823,7 +2823,7 @@ const likeDefinition: FunctionDefinition = {
},
],
supportedCommands: ['eval', 'where', 'row', 'sort'],
supportedOptions: ['by'],
supportedOptions: undefined,
validate: undefined,
examples: ['FROM employees\n| WHERE first_name LIKE """?b*"""\n| KEEP first_name, last_name'],
};
Expand All @@ -2834,7 +2834,7 @@ const matchOperatorDefinition: FunctionDefinition = {
name: ':',
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.match_operator', {
defaultMessage:
'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 fields from the text family like text and semantic_text,\nas well as other field types like keyword, boolean, dates, and numeric types.\n\nFor a simplified syntax, you can use the match operator `:` operator instead of `MATCH`.\n\n`MATCH` returns true if the provided query matches the row.',
'Use the match operator (`:`) to perform a match query on the specified field.\nUsing `:` is equivalent to using the `match` query in the Elasticsearch Query DSL.\n\nThe match operator is equivalent to the match function.\n\nFor using the function syntax, or adding match query parameters, you can use the\nmatch function.\n\n`:` returns true if the provided query matches the row.',
}),
preview: true,
alias: undefined,
Expand Down Expand Up @@ -4680,7 +4680,7 @@ const rlikeDefinition: FunctionDefinition = {
},
],
supportedCommands: ['eval', 'where', 'row', 'sort'],
supportedOptions: ['by'],
supportedOptions: undefined,
validate: undefined,
examples: [
'FROM employees\n| WHERE first_name RLIKE """.leja.*"""\n| KEEP first_name, last_name',
Expand Down
Loading

0 comments on commit 632cec7

Please sign in to comment.