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

This PR updates the function definitions and inline docs based on the latest metadata from Elasticsearch. Co-authored-by: Stratoula Kalafateli <[email protected]> (cherry picked from commit 9b07ca4)
kibanamachine · Jan 6, 2025 · 3806d37 · 3806d37
1 parent d58b812
commit 3806d37
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 1 deletion.
diff --git a/...kages/private/kbn-language-documentation/src/sections/generated/aggregation_functions.tsx b/...kages/private/kbn-language-documentation/src/sections/generated/aggregation_functions.tsx
@@ -318,6 +318,41 @@ 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.st_extent_agg', {
+        defaultMessage: 'ST_EXTENT_AGG',
+      }),
+      preview: false,
+      description: (
+        <Markdown
+          openLinksInNewTab
+          readOnly
+          enableSoftLineBreaks
+          markdownContent={i18n.translate(
+            'languageDocumentation.documentationESQL.st_extent_agg.markdown',
+            {
+              defaultMessage: `<!--
+  This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+  -->
+
+  ### ST_EXTENT_AGG
+  Calculate the spatial extent over a field with geometry type. Returns a bounding box for all values of the field.
+
+  \`\`\`
+  FROM airports
+  | WHERE country == "India"
+  | STATS extent = ST_EXTENT_AGG(location)
+  \`\`\`
   `,
               description:
                 'Text is in markdown. Do not translate function names, special characters, or field names like sum(bytes)',

diff --git a/...m/packages/private/kbn-language-documentation/src/sections/generated/scalar_functions.tsx b/...m/packages/private/kbn-language-documentation/src/sections/generated/scalar_functions.tsx
@@ -977,6 +977,33 @@ export const functions = {
       ),
     },
     // Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
+    {
+      label: i18n.translate('languageDocumentation.documentationESQL.hash', {
+        defaultMessage: 'HASH',
+      }),
+      preview: false,
+      description: (
+        <Markdown
+          openLinksInNewTab
+          readOnly
+          enableSoftLineBreaks
+          markdownContent={i18n.translate('languageDocumentation.documentationESQL.hash.markdown', {
+            defaultMessage: `<!--
+  This is generated by ESQL's AbstractFunctionTestCase. Do no edit it. See ../README.md for how to regenerate it.
+  -->
+
+  ### HASH
+  Computes the hash of the input using various algorithms such as MD5, SHA, SHA-224, SHA-256, SHA-384, SHA-512.
+
+  `,
+            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',
@@ -1311,7 +1338,14 @@ export const functions = {
   -->
 
   ### MATCH
-  Performs a match query on the specified field. Returns true if the provided query matches the row.
+  Use \`MATCH\` to perform a match query on the specified field.
+  Using \`MATCH\` is equivalent to using the \`match\` query in the Elasticsearch Query DSL.
+
+  Match can be used on text fields, as well as other field types like boolean, dates, and numeric types.
+
+  For a simplified syntax, you can use the match operator \`:\` operator instead of \`MATCH\`.
+
+  \`MATCH\` returns true if the provided query matches the row.
 
   \`\`\`
   FROM books