dt-sql-parser 4.0.0-ng.2 → 4.0.0

package/README.md

@@ -13,42 +13,27 @@
 
 English | [简体中文](./README-zh_CN.md)
 
-dt-sql-parser is a **SQL Parser** project built with [ANTLR4](https://github.com/antlr/antlr4), and it's mainly for the **BigData** field. The [ANTLR4](https://github.com/antlr/antlr4) generated the basic Parser, Visitor, and Listener, so it's easy to complete the **syntax validation**, **tokenizer**, **traverse** the AST, and so on features.
+dt-sql-parser is a **SQL Parser** project built with [ANTLR4](https://github.com/antlr/antlr4), and it's mainly for the **BigData** field. The [ANTLR4](https://github.com/antlr/antlr4) generated the basic Parser, Visitor, and Listener, so it's easy to complete the **Lexer**, **Parser**, **traverse the AST**, and so on features.
 
-Additionally, it provides auxiliary functions such as **SQL splitting** and **code completion**.
+Additionally, it provides advanced features such as **SQL Validation**, **Code Completion** and **Collecting Table and Columns in SQL**.
 
 **Supported SQL**:
 
 - MySQL
-- Flink SQL
-- Spark SQL
-- Hive SQL
+- Flink
+- Spark
+- Hive
 - PostgreSQL
-- Trino SQL
-- Impala SQL
+- Trino
+- Impala
 
-**Supported auxiliary methods**
-
-| SQL Type    | SQL Spliting | Code Completion |
-| ----------- | ------------ | --------------- |
-| MySQL       | ✅           | ✅               |
-| Flink SQL   | ✅           | ✅               |
-| Spark SQL   | ✅           | ✅               |
-| Hive SQL    | ✅           | ✅               |
-| PostgreSQL  | ✅           | ✅               |
-| Trino SQL   | ✅           | ✅               |
-| Impala SQL  | ✅           | ✅               |
-
->Tips: This project is the default for Javascript language, also you can try to compile it to other languages if you need.
+>Tips: This project is the default for Typescript target, also you can try to compile it to other languages if you need.
 
 <br/>
 
 ## Integrating SQL Parser with Monaco Editor
 
-We have provided [monaco-sql-languages](https://github.com/DTStack/monaco-sql-languages), it is easily to integrate with `monaco-editor`.
-
->Tips: If you want to run `dt-sql-parser` in browser, don't forget to install the `assert` and `util` polyfills, and define the global variable `process.env`.
-  None of this is needed in the node environment, because node has them built-in.
+We also have provided [monaco-sql-languages](https://github.com/DTStack/monaco-sql-languages) to easily to integrate `dt-sql-parser` with `monaco-editor`.
 
 <br/>
 
@@ -65,45 +50,30 @@ yarn add dt-sql-parser
 <br/>
 
 ## Usage
-We recommend learning the Fundamentals usage before continuing. The dt-sql-parser library provides SQL Parser classes for different types of SQL.
+We recommend learning the fundamentals usage before continuing. The dt-sql-parser library provides SQL classes for different types of SQL.
 ```javascript
-import { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgresSQL, TrinoSQL, ImpalaSQL } from 'dt-sql-parser';
+import { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgreSQL, TrinoSQL, ImpalaSQL } from 'dt-sql-parser';
 ```
 
 Before using syntax validation, code completion, and other features, it is necessary to instantiate the Parser of the relevant SQL type.
 For instance, one can consider using `MySQL` as an example:
 ```javascript
-const parser = new MySQL();
+const mysql = new MySQL();
 ```
 
 The following usage examples will utilize the `MySQL`, and the Parser for other SQL types will be used in a similar manner as `MySQL`.
 
 ### Syntax Validation
-```javascript
-import { MySQL } from 'dt-sql-parser';
-
-const parser = new MySQL();
-
-const correctSql = 'select id,name from user1;';
-const errors = parser.validate(correctSql);
-console.log(errors); 
-```
-
-*output:*
+First instanced a Parser object, then call the **validate** method on the SQL instance to validate the sql content, if failed returns an array includes **error** message.
 
 ```javascript
-/* 
-[]
-*/
-```
+import { MySQL } from 'dt-sql-parser';
 
-**Validate failed:**
+const mysql = new MySQL();
+const incorrectSql = 'selec id,name from user1;';
+const errors = mysql.validate(incorrectSql);
 
-```javascript
-const incorrectSql = 'selec id,name from user1;'
-const errors = parser.validate(incorrectSql);
 console.log(errors); 
-
 ```
 
 *output:*
@@ -116,25 +86,24 @@ console.log(errors);
     endLine: 1,
     startCol: 0,
     startLine: 1,
-    message: "mismatched input 'SELEC' expecting {<EOF>, 'ALTER', 'ANALYZE', 'CALL', 'CHANGE', 'CHECK', 'CREATE', 'DELETE', 'DESC', 'DESCRIBE', 'DROP', 'EXPLAIN', 'GET', 'GRANT', 'INSERT', 'KILL', 'LOAD', 'LOCK', 'OPTIMIZE', 'PURGE', 'RELEASE', 'RENAME', 'REPLACE', 'RESIGNAL', 'REVOKE', 'SELECT', 'SET', 'SHOW', 'SIGNAL', 'UNLOCK', 'UPDATE', 'USE', 'BEGIN', 'BINLOG', 'CACHE', 'CHECKSUM', 'COMMIT', 'DEALLOCATE', 'DO', 'FLUSH', 'HANDLER', 'HELP', 'INSTALL', 'PREPARE', 'REPAIR', 'RESET', 'ROLLBACK', 'SAVEPOINT', 'START', 'STOP', 'TRUNCATE', 'UNINSTALL', 'XA', 'EXECUTE', 'SHUTDOWN', '--', '(', ';'}"
+    message: "..."
   }
 ]
 */
 ```
 
-We instanced a Parser object, and use the **validate** method to check the SQL syntax, if failed
-returns an array object includes **error** message.
 
 ### Tokenizer
 
-Get all **tokens** by the Parser:
+Call the `getAllTokens` method on the SQL instance:
 
 ```javascript
 import { MySQL } from 'dt-sql-parser';
 
-const parser = new MySQL()
+const mysql = new MySQL()
 const sql = 'select id,name,sex from user1;'
-const tokens = parser.getAllTokens(sql)
+const tokens = mysql.getAllTokens(sql)
+
 console.log(tokens)
 ```
 
@@ -164,36 +133,28 @@ console.log(tokens)
 Traverse the tree node by the Visitor:
 
 ```typescript
-import { MySQL, AbstractParseTreeVisitor } from 'dt-sql-parser';
-import type { MySqlParserVisitor } from 'dt-sql-parser';
-
-const parser = new MySQL();
-const sql = `select id,name from user1;`;
-const tree = parser.parse(sql);
+import { MySQL, MySqlParserVisitor } from 'dt-sql-parser';
 
-type Result = string;
+const mysql = new MySQL();
+const sql = `select id, name from user1;`;
+const parseTree = mysql.parse(sql);
 
-class MyVisitor extends AbstractParseTreeVisitor<Result> implements MySqlParserVisitor<Result> {
-    protected defaultResult() {
-        return '';
-    }
-    visitTableName(ctx) {
-        let tableName = ctx.text.toLowerCase();
-        console.log('TableName:', tableName);
-        return '';
-    }
-    visitSelectElements(ctx) {
-        let selectElements = ctx.text.toLowerCase();
-        console.log('SelectElements:', selectElements);
+class MyVisitor extends MySqlParserVisitor<string> {
+    defaultResult(): string {
         return '';
     }
-    visitProgram(ctx) { // program is root rule
-        this.visitChildren(ctx);
-        return 'Return by program context'
+    aggregateResult(aggregate: string, nextResult: string): string {
+        return aggregate + nextResult;
     }
+    visitProgram = (ctx) => {
+        return this.visitChildren(ctx);
+    };
+    visitTableName = (ctx) => {
+        return ctx.getText();
+    };
 }
 const visitor = new MyVisitor();
-const result = visitor.visit(tree);
+const result = visitor.visit(parseTree);
 
 console.log(result);
 ```
@@ -202,60 +163,52 @@ console.log(result);
 
 ```javascript
 /*
-SelectElements: id,name
-TableName: user1
-*/
-/*
-Return by program node
+user1
 */
 ```
 
-> Tips: The node's method name can be found in the Visitor file under the corresponding SQL directory
-
 ### Listener
 
 Access the specified node in the AST by the Listener
 
 ```typescript
-import { MySQL } from 'dt-sql-parser';
-import type { MySqlParserListener } from 'dt-sql-parser';
+import { MySQL, MySqlParserListener } from 'dt-sql-parser';
 
-const parser = new MySQL();
-const sql = 'select id,name from user1;';
-const parseTree = parser.parse(sql);
+const mysql = new MySQL();
+const sql = 'select id, name from user1;';
+const parseTree = mysql.parse(sql);
 
-class MyListener implements MySqlParserListener {
-    enterTableName(ctx) {
-        let tableName = ctx.text.toLowerCase();
-        console.log('TableName:', tableName);
-    }
-    enterSelectElements(ctx) {
-        let selectElements = ctx.text.toLowerCase();
-        console.log('SelectElements:', selectElements);
-    }
+class MyListener extends MySqlParserListener {
+    result = '';
+    enterTableName = (ctx): void => {
+        this.result = ctx.getText();
+    };
 }
-const listenTableName = new MyListener();
-parser.listen(listenTableName as MySqlParserListener, parseTree);
+
+const listener = new MyListener();
+mysql.listen(listener, parseTree);
+
+console.log(listener.result)
 ```
 
 *output:*
 
 ```javascript
 /*
-SelectElements: id,name
-TableName: user1
+user1
 */
 ```
 
-> Tips: The node's method name can be found in the Listener file under the corresponding SQL directory
-
 ### Splitting SQL statements
-Take `FlinkSQL` as an example:
+Take `FlinkSQL` as an example, call the `splitSQLByStatement` method on the SQL instance:
+
 ```javascript
 import { FlinkSQL } from 'dt-sql-parser';
-const parser = new FlinkSQL();
+
+const flink = new FlinkSQL();
 const sql = 'SHOW TABLES;\nSELECT * FROM tb;';
-const sqlSlices = parser.splitSQLByStatement(sql);
+const sqlSlices = flink.splitSQLByStatement(sql);
+
 console.log(sqlSlices)
 ```
 
@@ -288,17 +241,18 @@ console.log(sqlSlices)
 
 ### Code Completion
 Obtaining code completion information at a specified position in SQL.
-We can refer to the example of using `FlinkSQL`.
 
-Invoke the `getSuggestionAtCaretPosition` method, pass the SQL content and the row and column numbers indicating the position where code completion is desired. The following are some additional explanations about [CaretPosition](#caretposition-of-code-completion).
+Call the `getAllEntities` method on the SQL instance, pass the SQL content and the row and column numbers indicating the position where code completion is desired. The following are some additional explanations about [CaretPosition](#caretposition-of-code-completion).
 + **keyword candidates list**
 
     ```javascript
     import { FlinkSQL } from 'dt-sql-parser';
-    const parser = new FlinkSQL();
+  
+    const flink = new FlinkSQL();
     const sql = 'CREATE ';
     const pos = { lineNumber: 1, column: 16 }; // the end position
-    const keywords = parser.getSuggestionAtCaretPosition(sql, pos)?.keywords;
+    const keywords = flink.getSuggestionAtCaretPosition(sql, pos)?.keywords;
+  
     console.log(keywords);
     ```
     *output:*
@@ -309,10 +263,13 @@ Invoke the `getSuggestionAtCaretPosition` method, pass the SQL content and the r
     ```
 +  **Obtaining information related to grammar completion**
     ```javascript
-    const parser = new FlinkSQL();
+    import { FlinkSQL } from 'dt-sql-parser';
+
+    const flink = new FlinkSQL();
     const sql = 'SELECT * FROM tb';
     const pos = { lineNumber: 1, column: 16 }; // after 'tb'
-    const syntaxSuggestions = parser.getSuggestionAtCaretPosition(sql, pos)?.syntax;
+    const syntaxSuggestions = flink.getSuggestionAtCaretPosition(sql, pos)?.syntax;
+
     console.log(syntaxSuggestions);
     ```
     *output:*
@@ -350,6 +307,55 @@ Invoke the `getSuggestionAtCaretPosition` method, pass the SQL content and the r
     ```
 The grammar-related code completion information returns an array, where each item represents what grammar can be filled in at that position. For example, the output in the above example represents that the position can be filled with either a **table name** or **a view name**. In this case, `syntaxContextType` represents the type of grammar that can be completed, and `wordRanges` represents the content that has already been filled.
 
+
+### Get all entities in SQL (e.g. table, column)
+Call the `getAllEntities` method on the SQL instance, and pass in the sql text and the row and column numbers at the specified location to easily get them.
+
+```typescript
+  import { FlinkSQL } from 'dt-sql-parser';
+
+  const flink = new FlinkSQL();
+  const sql = 'SELECT * FROM tb;';
+  const pos = { lineNumber: 1, column: 16 }; // tb 的后面
+  const entities = flink.getAllEntities(sql, pos);
+
+  console.log(entities);
+```
+
+*output*
+
+```typescript
+/*
+  [
+    {
+      entityContextType: 'table',
+      text: 'tb',
+      position: {
+        line: 1,
+        startIndex: 14,
+        endIndex: 15,
+        startColumn: 15,
+        endColumn: 17
+      },
+      belongStmt: {
+        stmtContextType: 'selectStmt',
+        position: [Object],
+        rootStmt: [Object],
+        parentStmt: [Object],
+        isContainCaret: true
+      },
+      relatedEntities: null,
+      columns: null,
+      isAlias: false,
+      origin: null,
+      alias: null
+    }
+  ]
+*/
+```
+
+Position is not required, if the position is passed, then in the collected entities, if the entity is located under the statement where the corresponding position is located, then the statement object to which the entity belongs will be marked with `isContainCaret`, which can help you quickly filter out the required entities when combined with the code completion function.
+
 ### Other API
 
 - `createLexer` Create an instance of Antlr4 Lexer and return it;
@@ -428,6 +434,7 @@ At this time, dt-sql-parser will think that `SHOW` is already a complete Token,
 For the editor, this strategy is also more intuitive. After the user enters `SHOW`, before pressing the space key, the user probably has not finished entering, maybe the user wants to enter something like `SHOWS`. When the user presses the space key, the editor thinks that the user wants to enter the next Token, and it is time to ask dt-sql-parser what can be filled in the next Token position.
 
 <br/>
+
 ## License
 
 [MIT](./LICENSE)

package/dist/index.d.ts

@@ -1,10 +1,18 @@
-export { AbstractParseTreeVisitor } from 'antlr4ng';
-export { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgresSQL, TrinoSQL, ImpalaSQL, PLSQL, } from './parser';
-export type { MySqlParserListener, MySqlParserVisitor, FlinkSqlParserListener, FlinkSqlParserVisitor, SparkSqlParserListener, SparkSqlParserVisitor, HiveSqlParserListener, HiveSqlParserVisitor, PlSqlParserListener, PlSqlParserVisitor, PostgreSQLParserListener, PostgreSQLParserVisitor, TrinoSqlListener, TrinoSqlVisitor, ImpalaSqlParserListener, ImpalaSqlParserVisitor, } from './lib';
-export { SyntaxContextType } from './parser/common/basic-parser-types';
-export type { CaretPosition, WordRange, Suggestions, SyntaxSuggestion, TextSlice, } from './parser/common/basic-parser-types';
+export { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgreSQL, TrinoSQL, ImpalaSQL, PLSQL, } from './parser';
+export { MySqlParserListener, MySqlParserVisitor, FlinkSqlParserListener, FlinkSqlParserVisitor, SparkSqlParserListener, SparkSqlParserVisitor, HiveSqlParserListener, HiveSqlParserVisitor, PlSqlParserListener, PlSqlParserVisitor, PostgreSqlParserListener, PostgreSqlParserVisitor, TrinoSqlListener, TrinoSqlVisitor, ImpalaSqlParserListener, ImpalaSqlParserVisitor, } from './lib';
+export { EntityContextType } from './parser/common/types';
+export { 
+/**
+ * @deprecated SyntaxContextType has been renamed to {@link EntityContextType},
+ * It will be removed when the stable version is released.
+ */
+EntityContextType as SyntaxContextType, } from './parser/common/types';
+export { StmtContextType } from './parser/common/entityCollector';
+export type { CaretPosition, 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 { StmtContext, EntityContext } from './parser/common/entityCollector';
 /**
- * @deprecated legacy, will be removed.
+ * @deprecated Legacy utils will be removed when the stable version is released.
  */
 export * from './utils';

package/dist/index.js

@@ -1,7 +1,14 @@
-export { AbstractParseTreeVisitor } from 'antlr4ng';
-export { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgresSQL, TrinoSQL, ImpalaSQL, PLSQL, } from './parser';
-export { SyntaxContextType } from './parser/common/basic-parser-types';
+export { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgreSQL, TrinoSQL, ImpalaSQL, PLSQL, } from './parser';
+export { MySqlParserListener, MySqlParserVisitor, FlinkSqlParserListener, FlinkSqlParserVisitor, SparkSqlParserListener, SparkSqlParserVisitor, HiveSqlParserListener, HiveSqlParserVisitor, PlSqlParserListener, PlSqlParserVisitor, PostgreSqlParserListener, PostgreSqlParserVisitor, TrinoSqlListener, TrinoSqlVisitor, ImpalaSqlParserListener, ImpalaSqlParserVisitor, } from './lib';
+export { EntityContextType } from './parser/common/types';
+export { 
 /**
- * @deprecated legacy, will be removed.
+ * @deprecated SyntaxContextType has been renamed to {@link EntityContextType},
+ * It will be removed when the stable version is released.
+ */
+EntityContextType as SyntaxContextType, } from './parser/common/types';
+export { StmtContextType } from './parser/common/entityCollector';
+/**
+ * @deprecated Legacy utils will be removed when the stable version is released.
  */
 export * from './utils';

package/dist/lib/SQLParserBase.d.ts

@@ -0,0 +1,8 @@
+import * as antlr from "antlr4ng";
+export declare abstract class SQLParserBase<T = antlr.ParserRuleContext> extends antlr.Parser {
+    constructor(input: antlr.TokenStream);
+    abstract program(): T;
+    caretTokenIndex: number;
+    entityCollecting: boolean;
+    shouldMatchEmpty(): boolean;
+}

package/dist/lib/SQLParserBase.js

@@ -0,0 +1,14 @@
+import * as antlr from "antlr4ng";
+export class SQLParserBase extends antlr.Parser {
+    constructor(input) {
+        super(input);
+        this.caretTokenIndex = -1;
+        this.entityCollecting = false;
+    }
+    shouldMatchEmpty() {
+        var _a, _b, _c, _d;
+        return this.entityCollecting
+            && ((_b = (_a = this.tokenStream.LT(-1)) === null || _a === void 0 ? void 0 : _a.tokenIndex) !== null && _b !== void 0 ? _b : Infinity) <= this.caretTokenIndex
+            && ((_d = (_c = this.tokenStream.LT(1)) === null || _c === void 0 ? void 0 : _c.tokenIndex) !== null && _d !== void 0 ? _d : -Infinity) >= this.caretTokenIndex;
+    }
+}

package/dist/lib/{flinksql → flink}/FlinkSqlLexer.d.ts

@@ -542,8 +542,8 @@ export declare class FlinkSqlLexer extends antlr.Lexer {
     static readonly BIT_STRING = 540;
     static readonly ID_LITERAL = 541;
     static readonly channelNames: string[];
-    static readonly literalNames: string[];
-    static readonly symbolicNames: string[];
+    static readonly literalNames: (string | null)[];
+    static readonly symbolicNames: (string | null)[];
     static readonly modeNames: string[];
     static readonly ruleNames: string[];
     constructor(input: antlr.CharStream);

package/dist/lib/{flinksql → flink}/FlinkSqlLexer.js

@@ -1,4 +1,5 @@
-// Generated from dt-sql-parser/src/grammar/flinksql/FlinkSqlLexer.g4 by ANTLR 4.13.1
+// Generated from dt-sql-parser/src/grammar/flink/FlinkSqlLexer.g4 by ANTLR 4.13.1
+// @ts-nocheck
 import * as antlr from "antlr4ng";
 class FlinkSqlLexer extends antlr.Lexer {
     constructor(input) {

package/dist/lib/{flinksql → flink}/FlinkSqlParser.d.ts

@@ -2,7 +2,8 @@ import * as antlr from "antlr4ng";
 import { Token } from "antlr4ng";
 import { FlinkSqlParserListener } from "./FlinkSqlParserListener.js";
 import { FlinkSqlParserVisitor } from "./FlinkSqlParserVisitor.js";
-export declare class FlinkSqlParser extends antlr.Parser {
+import { SQLParserBase } from '../SQLParserBase';
+export declare class FlinkSqlParser extends SQLParserBase {
     static readonly SPACE = 1;
     static readonly COMMENT_INPUT = 2;
     static readonly LINE_COMMENT = 3;
@@ -732,8 +733,8 @@ export declare class FlinkSqlParser extends antlr.Parser {
     static readonly RULE_reservedKeywordsUsedAsFuncParam = 185;
     static readonly RULE_reservedKeywordsUsedAsFuncName = 186;
     static readonly RULE_nonReservedKeywords = 187;
-    static readonly literalNames: string[];
-    static readonly symbolicNames: string[];
+    static readonly literalNames: (string | null)[];
+    static readonly symbolicNames: (string | null)[];
     static readonly ruleNames: string[];
     get grammarFileName(): string;
     get literalNames(): (string | null)[];
@@ -936,6 +937,7 @@ export declare class FlinkSqlParser extends antlr.Parser {
     reservedKeywordsUsedAsFuncName(): ReservedKeywordsUsedAsFuncNameContext;
     nonReservedKeywords(): NonReservedKeywordsContext;
     sempred(localContext: antlr.RuleContext | null, ruleIndex: number, predIndex: number): boolean;
+    private columnName_sempred;
     private queryStatement_sempred;
     private tableExpression_sempred;
     private booleanExpression_sempred;
@@ -1294,7 +1296,6 @@ export declare class ColumnNameCreateContext extends antlr.ParserRuleContext {
 export declare class ColumnNameContext extends antlr.ParserRuleContext {
     constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
     uid(): UidContext | null;
-    expression(): ExpressionContext | null;
     get ruleIndex(): number;
     enterRule(listener: FlinkSqlParserListener): void;
     exitRule(listener: FlinkSqlParserListener): void;
@@ -1585,13 +1586,6 @@ export declare class ApplyTransformContext extends TransformContext {
     exitRule(listener: FlinkSqlParserListener): void;
     accept<Result>(visitor: FlinkSqlParserVisitor<Result>): Result | null;
 }
-export declare class ColumnTransformContext extends TransformContext {
-    constructor(ctx: TransformContext);
-    qualifiedName(): QualifiedNameContext;
-    enterRule(listener: FlinkSqlParserListener): void;
-    exitRule(listener: FlinkSqlParserListener): void;
-    accept<Result>(visitor: FlinkSqlParserVisitor<Result>): Result | null;
-}
 export declare class TransformArgumentContext extends antlr.ParserRuleContext {
     constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
     qualifiedName(): QualifiedNameContext | null;