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

This PR updates the function definitions and inline docs based on the latest metadata from Elasticsearch.
e40pud · Dec 2, 2024 · 6ef4912 · 6ef4912
1 parent e2a99ca
commit 6ef4912
Showing 1 changed file with 45 additions and 2 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
@@ -620,7 +620,7 @@ const categorizeDefinition: FunctionDefinition = {
           optional: false,
         },
       ],
-      returnType: 'integer',
+      returnType: 'keyword',
     },
     {
       params: [
@@ -630,7 +630,7 @@ const categorizeDefinition: FunctionDefinition = {
           optional: false,
         },
       ],
-      returnType: 'integer',
+      returnType: 'keyword',
     },
   ],
   supportedCommands: ['stats', 'inlinestats', 'metrics', 'eval', 'where', 'row', 'sort'],
@@ -2476,6 +2476,48 @@ const ipPrefixDefinition: FunctionDefinition = {
   ],
 };
 
+// Do not edit this manually... generated by scripts/generate_function_definitions.ts
+const kqlDefinition: FunctionDefinition = {
+  type: 'eval',
+  name: 'kql',
+  description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.kql', {
+    defaultMessage:
+      'Performs a KQL query. Returns true if the provided KQL query string matches the row.',
+  }),
+  ignoreAsSuggestion: true,
+
+  preview: true,
+  alias: undefined,
+  signatures: [
+    {
+      params: [
+        {
+          name: 'query',
+          type: 'keyword',
+          optional: false,
+        },
+      ],
+      returnType: 'boolean',
+    },
+    {
+      params: [
+        {
+          name: 'query',
+          type: 'text',
+          optional: false,
+        },
+      ],
+      returnType: 'boolean',
+    },
+  ],
+  supportedCommands: ['stats', 'inlinestats', 'metrics', 'eval', 'where', 'row', 'sort'],
+  supportedOptions: ['by'],
+  validate: undefined,
+  examples: [
+    'FROM books \n| WHERE KQL("author: Faulkner")\n| KEEP book_no, author \n| SORT book_no \n| LIMIT 5;',
+  ],
+};
+
 // Do not edit this manually... generated by scripts/generate_function_definitions.ts
 const leastDefinition: FunctionDefinition = {
   type: 'eval',
@@ -9612,6 +9654,7 @@ export const scalarFunctionDefinitions = [
   greatestDefinition,
   hypotDefinition,
   ipPrefixDefinition,
+  kqlDefinition,
   leastDefinition,
   leftDefinition,
   lengthDefinition,