dt-sql-parser 4.5.1-beta.2 → 4.5.1

package/README.md

@@ -263,6 +263,18 @@ Call the `getAllEntities` method on the SQL instance, pass the SQL content and t
     [ 'CATALOG', 'FUNCTION', 'TEMPORARY', 'VIEW', 'DATABASE', 'TABLE' ] 
     */
     ```
+
+    Use the optional `keywordFilter` to remove unwanted keyword candidates. Return `true` to keep a keyword and `false` to remove it.
+
+    ```typescript
+    const sql = 'SELECT * FROM tb ';
+    const pos = { lineNumber: 1, column: sql.length + 1 };
+    const excludedKeywords = new Set(['WHERE', 'ORDER BY']);
+    const keywords = flink.getSuggestionAtCaretPosition(sql, pos, {
+        keywordFilter: (keyword) => !excludedKeywords.has(keyword),
+    })?.keywords;
+    ```
+
 +  **Obtaining information related to grammar completion**
     ```javascript
     import { FlinkSQL } from 'dt-sql-parser';

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgreSQL, TrinoSQL, ImpalaSQL, Ge
 export { MySqlParserListener, MySqlParserVisitor, FlinkSqlParserListener, FlinkSqlParserVisitor, SparkSqlParserListener, SparkSqlParserVisitor, HiveSqlParserListener, HiveSqlParserVisitor, PostgreSqlParserListener, PostgreSqlParserVisitor, TrinoSqlListener, TrinoSqlVisitor, ImpalaSqlParserListener, ImpalaSqlParserVisitor, GenericSqlListener, GenericSqlVisitor, } from './lib';
 export { EntityContextType } from './parser/common/types';
 export { StmtContextType } from './parser/common/entityCollector';
-export type { CaretPosition, Suggestions, SyntaxSuggestion } from './parser/common/types';
+export type { CaretPosition, SuggestionOptions, Suggestions, SyntaxSuggestion, } from './parser/common/types';
 export type { WordRange, TextSlice } from './parser/common/textAndWord';
 export type { SyntaxError, ParseError, ErrorListener } from './parser/common/parseErrorListener';
 export type { GenericSQLOptions } from './parser/generic';

package/dist/lib/SQLParserBase.d.ts

@@ -17,4 +17,13 @@ export declare abstract class SQLParserBase<T = antlr.ParserRuleContext> extends
      * prediction in non-entity-collecting contexts.
      */
     shouldMatchEmpty(ruleName?: string): boolean;
+    /**
+     * Semantic predicate to check whether the previous token and the next token
+     * are adjacent (no whitespace in between).
+     *
+     * Used to support hyphens inside Hive SET config property names, e.g.
+     * `set tez.grouping.max-size = 1`, while still rejecting invalid spacing
+     * like `set hive.a - b = 1`.
+     */
+    isNextTokenAdjacent(): boolean;
 }

package/dist/lib/SQLParserBase.js

@@ -46,4 +46,19 @@ export class SQLParserBase extends antlr.Parser {
         // This allows ANTLR to report errors naturally
         return false;
     }
+    /**
+     * Semantic predicate to check whether the previous token and the next token
+     * are adjacent (no whitespace in between).
+     *
+     * Used to support hyphens inside Hive SET config property names, e.g.
+     * `set tez.grouping.max-size = 1`, while still rejecting invalid spacing
+     * like `set hive.a - b = 1`.
+     */
+    isNextTokenAdjacent() {
+        const previousToken = this.tokenStream.LT(-1);
+        const nextToken = this.tokenStream.LT(1);
+        return (previousToken !== null &&
+            nextToken !== null &&
+            previousToken.stop + 1 === nextToken.start);
+    }
 }

package/dist/lib/hive/HiveSqlParser.d.ts

@@ -774,30 +774,32 @@ export declare class HiveSqlParser extends SQLParserBase {
     static readonly RULE_principalIdentifier = 329;
     static readonly RULE_nonReserved = 330;
     static readonly RULE_sql11ReservedKeywordsUsedAsFunctionName = 331;
-    static readonly RULE_configPropertiesItem = 332;
-    static readonly RULE_resourcePlanDdlStatements = 333;
-    static readonly RULE_mappingTypes = 334;
-    static readonly RULE_rpAssign = 335;
-    static readonly RULE_rpAssignList = 336;
-    static readonly RULE_rpUnassign = 337;
-    static readonly RULE_activate = 338;
-    static readonly RULE_enable = 339;
-    static readonly RULE_disable = 340;
-    static readonly RULE_year = 341;
-    static readonly RULE_month = 342;
-    static readonly RULE_week = 343;
-    static readonly RULE_day = 344;
-    static readonly RULE_hour = 345;
-    static readonly RULE_minute = 346;
-    static readonly RULE_second = 347;
-    static readonly RULE_decimal = 348;
-    static readonly RULE_emptyColumn = 349;
-    static readonly RULE_poolPath = 350;
-    static readonly RULE_poolPathAllowEmpty = 351;
-    static readonly RULE_triggerAtomExpression = 352;
-    static readonly RULE_triggerActionExpression = 353;
-    static readonly RULE_poolAssign = 354;
-    static readonly RULE_poolAssignList = 355;
+    static readonly RULE_configProperty = 332;
+    static readonly RULE_configPropertyPart = 333;
+    static readonly RULE_configPropertiesItem = 334;
+    static readonly RULE_resourcePlanDdlStatements = 335;
+    static readonly RULE_mappingTypes = 336;
+    static readonly RULE_rpAssign = 337;
+    static readonly RULE_rpAssignList = 338;
+    static readonly RULE_rpUnassign = 339;
+    static readonly RULE_activate = 340;
+    static readonly RULE_enable = 341;
+    static readonly RULE_disable = 342;
+    static readonly RULE_year = 343;
+    static readonly RULE_month = 344;
+    static readonly RULE_week = 345;
+    static readonly RULE_day = 346;
+    static readonly RULE_hour = 347;
+    static readonly RULE_minute = 348;
+    static readonly RULE_second = 349;
+    static readonly RULE_decimal = 350;
+    static readonly RULE_emptyColumn = 351;
+    static readonly RULE_poolPath = 352;
+    static readonly RULE_poolPathAllowEmpty = 353;
+    static readonly RULE_triggerAtomExpression = 354;
+    static readonly RULE_triggerActionExpression = 355;
+    static readonly RULE_poolAssign = 356;
+    static readonly RULE_poolAssignList = 357;
     static readonly literalNames: (string | null)[];
     static readonly symbolicNames: (string | null)[];
     static readonly ruleNames: string[];
@@ -1140,6 +1142,8 @@ export declare class HiveSqlParser extends SQLParserBase {
     principalIdentifier(): PrincipalIdentifierContext;
     nonReserved(): NonReservedContext;
     sql11ReservedKeywordsUsedAsFunctionName(): Sql11ReservedKeywordsUsedAsFunctionNameContext;
+    configProperty(): ConfigPropertyContext;
+    configPropertyPart(): ConfigPropertyPartContext;
     configPropertiesItem(): ConfigPropertiesItemContext;
     resourcePlanDdlStatements(): ResourcePlanDdlStatementsContext;
     mappingTypes(): MappingTypesContext;
@@ -1168,6 +1172,7 @@ export declare class HiveSqlParser extends SQLParserBase {
     private columnName_sempred;
     private columnNamePathAllowEmpty_sempred;
     private selectItem_sempred;
+    private configPropertyPart_sempred;
     private poolPathAllowEmpty_sempred;
     static readonly _serializedATN: number[];
     private static __ATN;
@@ -1281,13 +1286,8 @@ export declare class ExecStatementContext extends antlr.ParserRuleContext {
     KW_EXECUTE(): antlr.TerminalNode | null;
     constantList(): ConstantListContext | null;
     KW_SET(): antlr.TerminalNode | null;
-    configPropertiesItem(): ConfigPropertiesItemContext[];
-    configPropertiesItem(i: number): ConfigPropertiesItemContext | null;
+    configProperty(): ConfigPropertyContext | null;
     EQUAL(): antlr.TerminalNode | null;
-    DOT(): antlr.TerminalNode[];
-    DOT(i: number): antlr.TerminalNode | null;
-    COLON(): antlr.TerminalNode[];
-    COLON(i: number): antlr.TerminalNode | null;
     get ruleIndex(): number;
     enterRule(listener: HiveSqlParserListener): void;
     exitRule(listener: HiveSqlParserListener): void;
@@ -6182,6 +6182,30 @@ export declare class Sql11ReservedKeywordsUsedAsFunctionNameContext extends antl
     exitRule(listener: HiveSqlParserListener): void;
     accept<Result>(visitor: HiveSqlParserVisitor<Result>): Result | null;
 }
+export declare class ConfigPropertyContext extends antlr.ParserRuleContext {
+    constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
+    configPropertyPart(): ConfigPropertyPartContext[];
+    configPropertyPart(i: number): ConfigPropertyPartContext | null;
+    DOT(): antlr.TerminalNode[];
+    DOT(i: number): antlr.TerminalNode | null;
+    COLON(): antlr.TerminalNode[];
+    COLON(i: number): antlr.TerminalNode | null;
+    get ruleIndex(): number;
+    enterRule(listener: HiveSqlParserListener): void;
+    exitRule(listener: HiveSqlParserListener): void;
+    accept<Result>(visitor: HiveSqlParserVisitor<Result>): Result | null;
+}
+export declare class ConfigPropertyPartContext extends antlr.ParserRuleContext {
+    constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
+    configPropertiesItem(): ConfigPropertiesItemContext[];
+    configPropertiesItem(i: number): ConfigPropertiesItemContext | null;
+    MINUS(): antlr.TerminalNode[];
+    MINUS(i: number): antlr.TerminalNode | null;
+    get ruleIndex(): number;
+    enterRule(listener: HiveSqlParserListener): void;
+    exitRule(listener: HiveSqlParserListener): void;
+    accept<Result>(visitor: HiveSqlParserVisitor<Result>): Result | null;
+}
 export declare class ConfigPropertiesItemContext extends antlr.ParserRuleContext {
     constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
     id_(): Id_Context | null;