dt-sql-parser 4.0.0-beta.4.1 → 4.0.0-beta.4.3

package/README.md

@@ -15,9 +15,9 @@ 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** domain. 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.
 
-Besides, it provides some helper methods, like **split** SQL, and filter the `--` and `/**/` types of comments in SQL.
+Additionally, it provides auxiliary functions such as SQL splitting and Auto-Complete.
 
-Supported SQL:
+**Supported SQL**:
 
 - Generic SQL (MySQL)
 - Flink SQL
@@ -27,32 +27,56 @@ Supported SQL:
 - PostgreSQL
 - Trino SQL
 
+**Supported auxiliary methods**
+
+| SQL Type    | SQL Split | Auto-Complete |
+| ----------- | -------- | -------- |
+| Generic SQL | WIP      | WIP      |
+| Flink SQL   | ✅        | ✅        |
+| Spark SQL   | ✅        | ✅        |
+| Hive SQL    | ✅        | ✅        |
+| PL/SQL      | WIP      | WIP      |
+| Postgre SQL | WIP      | WIP      |
+| Trino SQL   | WIP      | WIP      |
+
 >Tips: This project is the default for Javascript language, also you can try to compile it to other languages if you need.
 
+<br/>
+
 ## Integrating SQL Parser with Monaco Editor
 
 We have provided a [monaco-sql-languages](https://github.com/DTStack/monaco-sql-languages) package, you can integrate with `monaco-editor`
 easily.
 
+<br/>
+
 ## Installation
 
 ```bash
-// use npm
+# use npm
 npm i dt-sql-parser --save
 
-// use yarn
+# use yarn
 yarn add dt-sql-parser
 ```
 
-## Usage
+<br/>
 
-### Syntax Validation
+## Usage
+We recommend learning the Fundamentals usage before continuing. The dt-sql-parser library provides SQL Parser classes for different types of SQL.
+```javascript
+import { GenericSQL, FlinkSQL, SparkSQL, HiveSQL, PLSQL, PostgresSQL, TrinoSQL } from 'dt-sql-parser';
+```
 
-First, we need to import the **Parser** object from `dt-sql-parser`, the different language needs
-different Parser, so if you need to handle the **Flink SQL**, you can import the **FlinkSQL Parser**.
+Before employing 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 `GenericSQL` as an example:
+```javascript
+const parser = new GenericSQL();
+```
 
-The below is a **GenericSQL Parser** example:
+The following usage examples will utilize the `GenericSQL`, and the Parser for other SQL types will be employed in a similar manner as `GenericSQL`.
 
+### Syntax Validation
 ```javascript
 import GenericSQL from 'dt-sql-parser/dist/parser/generic';
 
@@ -197,50 +221,107 @@ TableName user1
 
 > Tips: The node's method name can be found in the Listener file under the corresponding SQL directory
 
-### Clean
-
-Clear the **comments** and **spaces** before and after
-
+### Splitting SQL statements
+Take `FlinkSQL` as an example:
 ```javascript
-import { cleanSql } from 'dt-sql-parser';
-
-const sql = `-- comment comment
-select id,name from user1; `
-const cleanedSql = cleanSql(sql)
-console.log(cleanedSql)
+import { FlinkSQL } from 'dt-sql-parser';
+const parser = new FlinkSQL();
+const sql = 'SHOW TABLES;\nSELECT * FROM tb;';
+const sqlSlices = parser.splitSQLByStatement(sql);
+console.log(sqlSlices)
 
 /*
-select id,name from user1;
+[
+    {
+    startIndex: 0,
+    endIndex: 11,
+    startLine: 1,
+    endLine: 1,
+    startColumn: 1,
+    endColumn: 12,
+    text: 'SHOW TABLES;'
+    },
+    {
+    startIndex: 13,
+    endIndex: 29,
+    startLine: 2,
+    endLine: 2,
+    startColumn: 1,
+    endColumn: 17,
+    text: 'SELECT * FROM tb;'
+    }
+]
 */
-```
-
-### Split SQL
-
-When the SQL text is very big, you can think about to split it by `;` , and handle it by each line.
 
-```javascript
-import { splitSql } from 'dt-sql-parser';
-
-const sql = `select id,name from user1;
-select id,name from user2;`
-const sqlList = splitSql(sql)
-console.log(sqlList)
-
-/*
-["select id,name from user1;", "\nselect id,name from user2;"]
-*/
 ```
 
-### Other API
-
-- parserTreeToString(input: string)
+### Code Completion
+Obtaining autocomplete 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 auto-completion is desired.
++ keyword candidates list
+
+    ```javascript
+    import { FlinkSQL } from 'dt-sql-parser';
+    const parser = new FlinkSQL();
+    const sql = 'CREATE ';
+    const pos = { lineNumber: 1, column: 16 }; // the end position
+    const keywords = parser.getSuggestionAtCaretPosition(sql, pos)?.keywords;
+    console.log(keywords);
+
+    /*
+    [ 'CATALOG', 'FUNCTION', 'TEMPORARY', 'VIEW', 'DATABASE', 'TABLE' ] 
+    */ 
+    ```
++  Obtaining information related to grammar completion
+    ```javascript
+    const parser = new FlinkSQL();
+    const sql = 'SELECT * FROM tb';
+    const pos = { lineNumber: 1, column: 16 }; // after 'tb'
+    const syntaxSuggestions = parser.getSuggestionAtCaretPosition(sql, pos)?.syntax;
+    console.log(syntaxSuggestions);
+
+    /*
+    [
+      {
+        syntaxContextType: 'table',
+        wordRanges: [
+          {
+            text: 'tb',
+            startIndex: 14,
+            stopIndex: 15,
+            line: 1,
+            startColumn: 15,
+            stopColumn: 16
+          }
+        ]
+      },
+      {
+        syntaxContextType: 'view',
+        wordRanges: [
+          {
+            text: 'tb',
+            startIndex: 14,
+            stopIndex: 15,
+            line: 1,
+            startColumn: 15,
+            stopColumn: 16
+          }
+        ]
+      }
+    ]
+    */
+    ```
+The grammar-related autocomplete 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.
 
-Parse the input and convert the AST to a `List-like` tree string.
+### Other API
 
-## Roadmap
+- `createLexer` Create an instance of Antlr4 Lexer and return it;
+- `createParser` Create an instance of Antlr4 parser and return it;
+- `parse` Parses the input SQL and returns the parse tree;
 
-- Auto-complete
-- Code formatting
+<br/>
 
 ## License
 

package/dist/index.d.ts

@@ -4,16 +4,16 @@ export * from './lib/flinksql/FlinkSqlParserListener';
 export * from './lib/flinksql/FlinkSqlParserVisitor';
 export * from './lib/generic/SqlParserVisitor';
 export * from './lib/generic/SqlParserListener';
-export * from './lib/hive/HiveSqlListener';
-export * from './lib/hive/HiveSqlVisitor';
+export * from './lib/hive/HiveSqlParserListener';
+export * from './lib/hive/HiveSqlParserVisitor';
 export * from './lib/plsql/PlSqlParserListener';
 export * from './lib/plsql/PlSqlParserVisitor';
-export * from './lib/spark/SparkSqlVisitor';
-export * from './lib/spark/SparkSqlListener';
+export * from './lib/spark/SparkSqlParserVisitor';
+export * from './lib/spark/SparkSqlParserListener';
 export * from './lib/pgsql/PostgreSQLParserListener';
 export * from './lib/pgsql/PostgreSQLParserVisitor';
 export * from './lib/trinosql/TrinoSqlListener';
 export * from './lib/trinosql/TrinoSqlVisitor';
 export { SyntaxContextType } from './parser/common/basic-parser-types';
 export type * from './parser/common/basic-parser-types';
-export type { SyntaxError, ParserError } from './parser/common/parserErrorListener';
+export type { SyntaxError, ParseError, ErrorHandler } from './parser/common/parseErrorListener';

package/dist/index.js

@@ -4,12 +4,12 @@ export * from './lib/flinksql/FlinkSqlParserListener';
 export * from './lib/flinksql/FlinkSqlParserVisitor';
 export * from './lib/generic/SqlParserVisitor';
 export * from './lib/generic/SqlParserListener';
-export * from './lib/hive/HiveSqlListener';
-export * from './lib/hive/HiveSqlVisitor';
+export * from './lib/hive/HiveSqlParserListener';
+export * from './lib/hive/HiveSqlParserVisitor';
 export * from './lib/plsql/PlSqlParserListener';
 export * from './lib/plsql/PlSqlParserVisitor';
-export * from './lib/spark/SparkSqlVisitor';
-export * from './lib/spark/SparkSqlListener';
+export * from './lib/spark/SparkSqlParserVisitor';
+export * from './lib/spark/SparkSqlParserListener';
 export * from './lib/pgsql/PostgreSQLParserListener';
 export * from './lib/pgsql/PostgreSQLParserVisitor';
 export * from './lib/trinosql/TrinoSqlListener';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC"}