[Auto Suggest] PPL & SQL Value Suggestion

changelogs/fragments/8275.yml

@@ -0,0 +1,2 @@
+feat:
+- Autocomplete Value Suggestion ([#8275](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/8275))

src/plugins/data/common/constants.ts

@@ -105,6 +105,8 @@ export const UI_SETTINGS = {
   FILTERS_PINNED_BY_DEFAULT: 'filters:pinnedByDefault',
   FILTERS_EDITOR_SUGGEST_VALUES: 'filterEditor:suggestValues',
   QUERY_ENHANCEMENTS_ENABLED: 'query:enhancements:enabled',
+  QUERY_ENHANCEMENTS_SUGGEST_VALUES: 'query:enhancements:suggestValues',
+  QUERY_ENHANCEMENTS_SUGGEST_VALUES_LIMIT: 'query:enhancements:suggestValuesLimit',
   QUERY_DATAFRAME_HYDRATION_STRATEGY: 'query:dataframe:hydrationStrategy',
   SEARCH_QUERY_LANGUAGE_BLOCKLIST: 'search:queryLanguageBlocklist',
   NEW_HOME_PAGE: 'home:useNewHomePage',

src/plugins/data/public/antlr/opensearch_ppl/code_completion.ts

@@ -11,11 +11,11 @@
 
 import { monaco } from '@osd/monaco';
 import { CursorPosition, OpenSearchPplAutocompleteResult } from '../shared/types';
-import { fetchFieldSuggestions, parseQuery } from '../shared/utils';
+import { fetchColumnValues, fetchFieldSuggestions, parseQuery } from '../shared/utils';
 import { openSearchPplAutocompleteData } from './opensearch_ppl_autocomplete';
 import { QuerySuggestion, QuerySuggestionGetFnArgs } from '../../autocomplete';
 import { SuggestionItemDetailsTags } from '../shared/constants';
-import { PPL_AGGREGATE_FUNTIONS } from './constants';
+import { PPL_AGGREGATE_FUNCTIONS } from './constants';
 import { OpenSearchPPLParser } from './.generated/OpenSearchPPLParser';
 
 export const getSuggestions = async ({
@@ -40,16 +40,50 @@
       finalSuggestions.push(...fetchFieldSuggestions(indexPattern, (f: any) => `${f} `));
     }
 
+    if (suggestions.suggestValuesForColumn) {
+      // get dataset for connecting to the cluster currently engaged
+      const dataset = services.data.query.queryString.getQuery().dataset;
+
+      // take the column and push in values for that column
+      const res = await fetchColumnValues(
+        [indexPattern.title],
+        suggestions.suggestValuesForColumn,
+        services,
+        dataset
+      );
+
+      let i = 0;
+      finalSuggestions.push(
+        ...res.body.fields[0].values.map((val: any) => {
+          i++;
+          return {
+            text: val.toString(),
+            insertText: typeof val === 'string' ? `"${val}" ` : `${val} `,
+            type: monaco.languages.CompletionItemKind.Value,
+            detail: SuggestionItemDetailsTags.Value,
+            sortText: i.toString().padStart(3, '0'),
+          };
+        })
+      );
+    }
+
     if (suggestions.suggestAggregateFunctions) {
       finalSuggestions.push(
-        ...PPL_AGGREGATE_FUNTIONS.map((af) => ({
+        ...PPL_AGGREGATE_FUNCTIONS.map((af) => ({
           text: `${af}()`,
           type: monaco.languages.CompletionItemKind.Function,
           insertText: af + '(${1:expr}) ',
           detail: SuggestionItemDetailsTags.AggregateFunction,
           insertTextRules: monaco.languages.CompletionItemInsertTextRule.InsertAsSnippet,
         }))
       );
+      // separately include count as there will be nothing within the parens
+      finalSuggestions.push({
+        text: `count()`,
+        type: monaco.languages.CompletionItemKind.Function,
+        insertText: 'count() ',
+        detail: SuggestionItemDetailsTags.AggregateFunction,
+      });
     }
 
     if (suggestions.suggestSourcesOrTables) {
@@ -61,7 +95,7 @@
       });
     }
 
-    // create the sortlist
+    // create the keyword sortlist
     const suggestionImportance = new Map<number, string>();
     suggestionImportance.set(OpenSearchPPLParser.PIPE, '0');
     suggestionImportance.set(OpenSearchPPLParser.COMMA, '1');

src/plugins/data/public/antlr/opensearch_ppl/constants.ts

@@ -3,9 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export const PPL_AGGREGATE_FUNTIONS = [
+export const PPL_AGGREGATE_FUNCTIONS = [
   'avg',
-  'count',
   'sum',
   'min',
   'max',

src/plugins/data/public/antlr/opensearch_ppl/grammar/OpenSearchPPLParser.g4

@@ -177,7 +177,7 @@ tableSourceClause
    ;
 
 renameClasue
-   : orignalField = wcFieldExpression AS renamedField = wcFieldExpression
+   : orignalField = fieldExpression AS renamedField = ID
    ;
 
 byClause
@@ -258,7 +258,7 @@ logicalExpression
    ;
 
 comparisonExpression
-   : left = valueExpression comparisonOperator right = valueExpression  # compareExpr
+   : left = valueExpression comparisonOperator right = literalValue  # compareExpr
    | valueExpression IN valueList                                       # inExpr
    ;
 
@@ -696,11 +696,11 @@ stringLiteral
    ;
 
 integerLiteral
-   : (PLUS | MINUS)? INTEGER_LITERAL
+   : INTEGER_LITERAL
    ;
 
 decimalLiteral
-   : (PLUS | MINUS)? DECIMAL_LITERAL
+   : DECIMAL_LITERAL
    ;
 
 booleanLiteral

src/plugins/data/public/antlr/opensearch_ppl/opensearch_ppl_autocomplete.ts

@@ -36,16 +36,18 @@
     OpenSearchPPLParser.COMMA,
     OpenSearchPPLParser.PLUS,
     OpenSearchPPLParser.MINUS,
-    // OpenSearchPPLParser.EQUAL,
-    // OpenSearchPPLParser.NOT_EQUAL,
-    // OpenSearchPPLParser.LESS,
-    // OpenSearchPPLParser.NOT_LESS,
-    // OpenSearchPPLParser.GREATER,
-    // OpenSearchPPLParser.NOT_GREATER,
-    // OpenSearchPPLParser.OR,
-    // OpenSearchPPLParser.AND,
-    // OpenSearchPPLParser.XOR,
-    // OpenSearchPPLParser.NOT,
+    OpenSearchPPLParser.EQUAL,
+    OpenSearchPPLParser.NOT_EQUAL,
+    OpenSearchPPLParser.LESS,
+    OpenSearchPPLParser.NOT_LESS,
+    OpenSearchPPLParser.GREATER,
+    OpenSearchPPLParser.NOT_GREATER,
+    OpenSearchPPLParser.OR,
+    OpenSearchPPLParser.AND,
+    OpenSearchPPLParser.XOR,
+    OpenSearchPPLParser.NOT,
+    OpenSearchPPLParser.LT_PRTHS,
+    OpenSearchPPLParser.RT_PRTHS,
   ];
   for (let i = firstFunctionIndex; i <= lastFunctionIndex; i++) {
     if (!operatorsToInclude.includes(i)) {
@@ -64,6 +66,8 @@
   CLOSING_BRACKET: OpenSearchPPLParser.RT_PRTHS,
   SEARCH: OpenSearchPPLParser.SEARCH,
   SOURCE: OpenSearchPPLParser.SOURCE,
+  PIPE: OpenSearchPPLParser.PIPE,
+  ID: OpenSearchPPLParser.ID,
 };
 
 const rulesToVisit = new Set([
@@ -78,6 +82,7 @@
   OpenSearchPPLParser.RULE_multiFieldRelevanceFunctionName,
   OpenSearchPPLParser.RULE_positionFunctionName,
   OpenSearchPPLParser.RULE_evalFunctionName,
+  OpenSearchPPLParser.RULE_literalValue,
 ]);
 
 export function processVisitedRules(
@@ -88,6 +93,7 @@
   let suggestSourcesOrTables: OpenSearchPplAutocompleteResult['suggestSourcesOrTables'];
   let suggestAggregateFunctions = false;
   let shouldSuggestColumns = false;
+  let suggestValuesForColumn: string | undefined;
 
   for (const [ruleId, rule] of rules) {
     switch (ruleId) {
@@ -101,6 +107,22 @@
       }
       case OpenSearchPPLParser.RULE_tableQualifiedName: {
         suggestSourcesOrTables = SourceOrTableSuggestion.TABLES;
+        break;
+      }
+      case OpenSearchPPLParser.RULE_literalValue: {
+        let currentIndex = cursorTokenIndex - 1;
+        while (currentIndex > -1) {
+          const token = tokenStream.get(currentIndex);
+          if (token.type === tokenDictionary.PIPE) {
+            break;
+          }
+          if (token.type === tokenDictionary.ID) {
+            suggestValuesForColumn = token.text;
+            break;
+          }
+          currentIndex--;
+        }
+        break;
       }
     }
   }
@@ -109,6 +131,7 @@
     suggestSourcesOrTables,
     suggestAggregateFunctions,
     shouldSuggestColumns,
+    suggestValuesForColumn,
   };
 }
 
@@ -145,7 +168,7 @@
   const result: OpenSearchPplAutocompleteResult = {
     ...baseResult,
     ...suggestionsFromRules,
-    suggestColumns: shouldSuggestColumns ? ({ name: '' } as TableContextSuggestion) : undefined,
+    suggestColumns: shouldSuggestColumns ? ({} as TableContextSuggestion) : undefined,
   };
   return result;
 }

src/plugins/data/public/antlr/opensearch_sql/.generated/OpenSearchSQLLexer.ts

@@ -1,4 +1,4 @@
-// Generated from ./src/plugins/data/public/antlr/opensearch_sql/grammar/OpenSearchSQLLexer.g4 by ANTLR 4.13.1
+// Generated from grammar/OpenSearchSQLLexer.g4 by ANTLR 4.13.1
 
 import * as antlr from "antlr4ng";
 import { Token } from "antlr4ng";