[ES|QL] Update function metadata (#201515)

This PR updates the function definitions and inline docs based on the
latest metadata from Elasticsearch.
This commit is contained in:
Kibana Machine 2024-11-25 18:10:24 +11:00 committed by GitHub
parent 3e10e6053b
commit 30536b1d8c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 85 additions and 0 deletions

View file

@ -1341,6 +1341,56 @@ const stCentroidAggDefinition: FunctionDefinition = {
examples: ['FROM airports\n| STATS centroid=ST_CENTROID_AGG(location)'],
};
// Do not edit this manually... generated by scripts/generate_function_definitions.ts
const stdDevDefinition: FunctionDefinition = {
type: 'agg',
name: 'std_dev',
description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.std_dev', {
defaultMessage: 'The standard deviation of a numeric field.',
}),
preview: false,
alias: undefined,
signatures: [
{
params: [
{
name: 'number',
type: 'double',
optional: false,
},
],
returnType: 'double',
},
{
params: [
{
name: 'number',
type: 'integer',
optional: false,
},
],
returnType: 'double',
},
{
params: [
{
name: 'number',
type: 'long',
optional: false,
},
],
returnType: 'double',
},
],
supportedCommands: ['stats', 'inlinestats', 'metrics'],
supportedOptions: undefined,
validate: undefined,
examples: [
'FROM employees\n| STATS STD_DEV(height)',
'FROM employees\n| STATS stddev_salary_change = STD_DEV(MV_MAX(salary_change))',
],
};
// Do not edit this manually... generated by scripts/generate_function_definitions.ts
const sumDefinition: FunctionDefinition = {
type: 'agg',
@ -1871,6 +1921,7 @@ export const aggregationFunctionDefinitions = [
minDefinition,
percentileDefinition,
stCentroidAggDefinition,
stdDevDefinition,
sumDefinition,
topDefinition,
valuesDefinition,

View file

@ -318,6 +318,40 @@ export const functions = {
FROM airports
| STATS centroid=ST_CENTROID_AGG(location)
\`\`\`
`,
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.std_dev', {
defaultMessage: 'STD_DEV',
}),
preview: false,
description: (
<Markdown
openLinksInNewTab
readOnly
enableSoftLineBreaks
markdownContent={i18n.translate(
'languageDocumentation.documentationESQL.std_dev.markdown',
{
defaultMessage: `<!--
This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
-->
### STD_DEV
The standard deviation of a numeric field.
\`\`\`
FROM employees
| STATS STD_DEV(height)
\`\`\`
`,
description:
'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',