interpret snapshot_only as ignoreAsSuggestion

elastic · Oct 10, 2024 · d25f664 · d25f664
1 parent 9225728
commit d25f664
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/packages/kbn-esql-validation-autocomplete/scripts/generate_function_definitions.ts b/packages/kbn-esql-validation-autocomplete/scripts/generate_function_definitions.ts
@@ -254,6 +254,7 @@ function getFunctionDefinition(ESFunctionDefinition: Record<string, any>): Funct
       : aggregationSupportedCommandsAndOptions),
     description: ESFunctionDefinition.description,
     alias: aliasTable[ESFunctionDefinition.name],
+    ignoreAsSuggestion: ESFunctionDefinition.snapshot_only,
     signatures: _.uniqBy(
       ESFunctionDefinition.signatures.map((signature: any) => ({
         ...signature,
@@ -332,7 +333,7 @@ function printGeneratedFunctionsFile(
     name: '${name}',
     description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.${name}', { defaultMessage: ${JSON.stringify(
       removeAsciiDocInternalCrossReferences(removeInlineAsciiDocLinks(description), functionNames)
-    )} }),
+    )} }),${functionDefinition.ignoreAsSuggestion ? 'ignoreAsSuggestion: true,\n' : ''}
     alias: ${alias ? `['${alias.join("', '")}']` : 'undefined'},
     signatures: ${JSON.stringify(signatures, null, 2)},
     supportedCommands: ${JSON.stringify(functionDefinition.supportedCommands)},

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
@@ -524,6 +524,8 @@ const categorizeDefinition: FunctionDefinition = {
   description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.categorize', {
     defaultMessage: 'Categorizes text messages.',
   }),
+  ignoreAsSuggestion: true,
+
   alias: undefined,
   signatures: [
     {
@@ -3607,7 +3609,7 @@ const mvFirstDefinition: FunctionDefinition = {
   name: 'mv_first',
   description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.mv_first', {
     defaultMessage:
-      "Converts a multivalued expression into a single valued column containing the\nfirst value. This is most useful when reading from a function that emits\nmultivalued columns in a known order like `SPLIT`.\n\nThe order that  multivalued fields are read from\nunderlying storage is not guaranteed. It is *frequently* ascending, but don't\nrely on that. If you need the minimum value use `MV_MIN` instead of\n`MV_FIRST`. `MV_MIN` has optimizations for sorted values so there isn't a\nperformance benefit to `MV_FIRST`.",
+      'Converts a multivalued expression into a single valued column containing the\nfirst value. This is most useful when reading from a function that emits\nmultivalued columns in a known order like `SPLIT`.',
   }),
   alias: undefined,
   signatures: [
@@ -3764,7 +3766,7 @@ const mvLastDefinition: FunctionDefinition = {
   name: 'mv_last',
   description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.mv_last', {
     defaultMessage:
-      "Converts a multivalue expression into a single valued column containing the last\nvalue. This is most useful when reading from a function that emits multivalued\ncolumns in a known order like `SPLIT`.\n\nThe order that  multivalued fields are read from\nunderlying storage is not guaranteed. It is *frequently* ascending, but don't\nrely on that. If you need the maximum value use `MV_MAX` instead of\n`MV_LAST`. `MV_MAX` has optimizations for sorted values so there isn't a\nperformance benefit to `MV_LAST`.",
+      'Converts a multivalue expression into a single valued column containing the last\nvalue. This is most useful when reading from a function that emits multivalued\ncolumns in a known order like `SPLIT`.',
   }),
   alias: undefined,
   signatures: [
@@ -4474,7 +4476,7 @@ const mvSliceDefinition: FunctionDefinition = {
   name: 'mv_slice',
   description: i18n.translate('kbn-esql-validation-autocomplete.esql.definitions.mv_slice', {
     defaultMessage:
-      'Returns a subset of the multivalued field using the start and end index values.',
+      'Returns a subset of the multivalued field using the start and end index values.\nThis is most useful when reading from a function that emits multivalued columns\nin a known order like `SPLIT` or `MV_SORT`.',
   }),
   alias: undefined,
   signatures: [
@@ -5511,6 +5513,8 @@ const qstrDefinition: FunctionDefinition = {
     defaultMessage:
       'Performs a query string query. Returns true if the provided query string matches the row.',
   }),
+  ignoreAsSuggestion: true,
+
   alias: undefined,
   signatures: [
     {