mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
[ES|QL] Update function metadata (#224012)
This PR updates the function definitions and inline docs based on the latest metadata from Elasticsearch.
This commit is contained in:
parent
fff8ae9bcc
commit
3280da81e7
4 changed files with 46 additions and 4 deletions
|
@ -379,7 +379,7 @@ export const functions = {
|
|||
{
|
||||
defaultMessage: `
|
||||
### STD DEV
|
||||
The standard deviation of a numeric field.
|
||||
The population standard deviation of a numeric field.
|
||||
|
||||
\`\`\`esql
|
||||
FROM employees
|
||||
|
|
|
@ -1206,6 +1206,48 @@ export const functions = {
|
|||
FROM books
|
||||
| WHERE MATCH(author, "Faulkner")
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
ignoreTag: true,
|
||||
}
|
||||
)}
|
||||
/>
|
||||
),
|
||||
},
|
||||
// Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
|
||||
{
|
||||
label: i18n.translate('languageDocumentation.documentationESQL.match_phrase', {
|
||||
defaultMessage: 'MATCH_PHRASE',
|
||||
}),
|
||||
preview: true,
|
||||
description: (
|
||||
<Markdown
|
||||
openLinksInNewTab
|
||||
readOnly
|
||||
enableSoftLineBreaks
|
||||
markdownContent={i18n.translate(
|
||||
'languageDocumentation.documentationESQL.match_phrase.markdown',
|
||||
{
|
||||
defaultMessage: `
|
||||
### MATCH PHRASE
|
||||
Use \`MATCH_PHRASE\` to perform a [\`match_phrase\`](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase) on the
|
||||
specified field.
|
||||
Using \`MATCH_PHRASE\` is equivalent to using the \`match_phrase\` query in the Elasticsearch Query DSL.
|
||||
|
||||
MatchPhrase can be used on [text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/text) fields, as well as other field types like keyword, boolean, or date types.
|
||||
MatchPhrase is not supported for [semantic_text](https://www.elastic.co/docs/reference/elasticsearch/mapping-reference/semantic-text) or numeric types.
|
||||
|
||||
MatchPhrase can use [function named parameters](https://www.elastic.co/docs/reference/query-languages/esql/esql-syntax#esql-function-named-params) to specify additional options for the
|
||||
match_phrase query.
|
||||
All [\`match_phrase\`](https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase) query parameters are supported.
|
||||
|
||||
\`MATCH_PHRASE\` returns true if the provided query matches the row.
|
||||
|
||||
\`\`\`esql
|
||||
FROM books
|
||||
| WHERE MATCH_PHRASE(author, "William Faulkner")
|
||||
\`\`\`
|
||||
`,
|
||||
description:
|
||||
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',
|
||||
|
|
|
@ -1622,7 +1622,7 @@ const stdDevDefinition: FunctionDefinition = {
|
|||
type: FunctionDefinitionTypes.AGG,
|
||||
name: 'std_dev',
|
||||
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.std_dev', {
|
||||
defaultMessage: 'The standard deviation of a numeric field.',
|
||||
defaultMessage: 'The population standard deviation of a numeric field.',
|
||||
}),
|
||||
preview: false,
|
||||
alias: undefined,
|
||||
|
|
|
@ -1935,7 +1935,7 @@ const dateTruncDefinition: FunctionDefinition = {
|
|||
params: [
|
||||
{
|
||||
name: 'interval',
|
||||
type: 'date_period',
|
||||
type: 'time_duration',
|
||||
optional: false,
|
||||
},
|
||||
{
|
||||
|
@ -4742,7 +4742,6 @@ const matchPhraseDefinition: FunctionDefinition = {
|
|||
defaultMessage:
|
||||
'Use `MATCH_PHRASE` to perform a `match_phrase` on the\nspecified field.\nUsing `MATCH_PHRASE` is equivalent to using the `match_phrase` query in the Elasticsearch Query DSL.\n\nMatchPhrase can be used on text fields, as well as other field types like keyword, boolean, or date types.\nMatchPhrase is not supported for semantic_text or numeric types.\n\nMatchPhrase can use function named parameters to specify additional options for the\nmatch_phrase query.\nAll `match_phrase` query parameters are supported.\n\n`MATCH_PHRASE` returns true if the provided query matches the row.',
|
||||
}),
|
||||
ignoreAsSuggestion: true,
|
||||
preview: true,
|
||||
alias: undefined,
|
||||
signatures: [
|
||||
|
@ -10674,6 +10673,7 @@ const stGeohexToStringDefinition: FunctionDefinition = {
|
|||
Location.WHERE,
|
||||
Location.STATS,
|
||||
Location.STATS_BY,
|
||||
Location.STATS_WHERE,
|
||||
Location.COMPLETION,
|
||||
],
|
||||
validate: undefined,
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue