[ES|QL] Update function metadata (elastic#196047)

This PR updates the function definitions and inline docs based on the latest metadata from Elasticsearch. Co-authored-by: Stratoula Kalafateli <[email protected]>
CAWilson94 · Oct 14, 2024 · 08715c6 · 08715c6
1 parent 4c4cb1e
commit 08715c6
Show file tree

Hide file tree

Showing 2 changed files with 292 additions and 0 deletions.
diff --git a/packages/kbn-esql-validation-autocomplete/src/definitions/generated/scalar_functions.ts b/packages/kbn-esql-validation-autocomplete/src/definitions/generated/scalar_functions.ts
@@ -2015,6 +2015,263 @@ const greatestDefinition: FunctionDefinition = {
   examples: ['ROW a = 10, b = 20\n| EVAL g = GREATEST(a, b)'],
 };
 
+// Do not edit this manually... generated by scripts/generate_function_definitions.ts
+const hypotDefinition: FunctionDefinition = {
+  type: 'eval',
+  name: 'hypot',
+  description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.hypot', {
+    defaultMessage:
+      'Returns the hypotenuse of two numbers. The input can be any numeric values, the return value is always a double.\nHypotenuses of infinities are null.',
+  }),
+  alias: undefined,
+  signatures: [
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'double',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'double',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'double',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'integer',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'double',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'double',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'unsigned_long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'integer',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'double',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'integer',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'integer',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'integer',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'integer',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'unsigned_long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'double',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'integer',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'unsigned_long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'unsigned_long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'double',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'unsigned_long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'integer',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'unsigned_long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+    {
+      params: [
+        {
+          name: 'number1',
+          type: 'unsigned_long',
+          optional: false,
+        },
+        {
+          name: 'number2',
+          type: 'unsigned_long',
+          optional: false,
+        },
+      ],
+      returnType: 'double',
+    },
+  ],
+  supportedCommands: ['stats', 'inlinestats', 'metrics', 'eval', 'where', 'row', 'sort'],
+  supportedOptions: ['by'],
+  validate: undefined,
+  examples: ['ROW a = 3.0, b = 4.0\n| EVAL c = HYPOT(a, b)'],
+};
+
 // Do not edit this manually... generated by scripts/generate_function_definitions.ts
 const ipPrefixDefinition: FunctionDefinition = {
   type: 'eval',
@@ -8811,6 +9068,7 @@ export const scalarFunctionDefinitions = [
   floorDefinition,
   fromBase64Definition,
   greatestDefinition,
+  hypotDefinition,
   ipPrefixDefinition,
   leastDefinition,
   leftDefinition,

diff --git a/packages/kbn-language-documentation/src/sections/generated/scalar_functions.tsx b/packages/kbn-language-documentation/src/sections/generated/scalar_functions.tsx
@@ -834,6 +834,40 @@ export const functions = {
   | EVAL g = GREATEST(a, b)
   \`\`\`
   Note: When run on \`keyword\` or \`text\` fields, this returns the last string in alphabetical order. When run on \`boolean\` columns this will return \`true\` if any values are \`true\`.
+  `,
+              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.hypot', {
+        defaultMessage: 'HYPOT',
+      }),
+      description: (
+        <Markdown
+          openLinksInNewTab
+          readOnly
+          enableSoftLineBreaks
+          markdownContent={i18n.translate(
+            'languageDocumentation.documentationESQL.hypot.markdown',
+            {
+              defaultMessage: `<!--
+  This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+  -->
+
+  ### HYPOT
+  Returns the hypotenuse of two numbers. The input can be any numeric values, the return value is always a double.
+  Hypotenuses of infinities are null.
+
+  \`\`\`
+  ROW a = 3.0, b = 4.0
+  | EVAL c = HYPOT(a, b)
+  \`\`\`
   `,
               description:
                 'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',