Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ES|QL] Update function metadata #209231

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+273 −4
Open

[ES|QL] Update function metadata #209231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ccdcff1
Update function metadata
kibanamachine Feb 3, 2025
c062bb1
Fix types
stratoula Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...m/packages/private/kbn-language-documentation/src/sections/generated/scalar_functions.tsx
View file
Open in desktop
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
6 changes: 3 additions & 3 deletions ...m/packages/shared/kbn-esql-validation-autocomplete/src/definitions/generated/operators.ts
View file
Open in desktop
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