dt-sql-parser 4.1.2-beta.0 → 4.2.0

package/README.md

@@ -357,6 +357,57 @@ Call the `getAllEntities` method on the SQL instance, and pass in the sql text a
 
 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.
 
+### Get semantic context information
+
+Call the `getSemanticContextAtCaretPosition` method on the SQL instance, passing in the sql text and the line and column numbers at the specified position, for example:
+
+```typescript
+import { HiveSQL } from 'dt-sql-parser';
+
+const hive = new HiveSQL();
+const sql = 'SELECT * FROM tb;';
+const pos = { lineNumber: 1, column: 18 }; // after 'tb;'
+const semanticContext = hive.getSemanticContextAtCaretPosition(sql, pos);
+
+console.log(semanticContext);
+```
+
+*output*
+
+```typescript
+/*
+{
+  isStatementBeginning: true,
+}
+*/
+```
+
+Currently, the semantic context information that can be collected is as follows. If there are more requirements, please submit an [issue](https://github.com/DTStack/dt-sql-parser/issues).
+
+- `isStatementBeginning` Whether the current input position is the beginning of a statement
+
+The **default strategy** for `isStatementBeginning` is `SqlSplitStrategy.STRICT`
+
+There are two optional strategies:
+- `SqlSplitStrategy.STRICT` Strict strategy, only the statement delimiter `;` is used as the identifier for the end of the previous statement
+- `SqlSplitStrategy.LOOSE` Loose strategy, based on the syntax parsing tree to split SQL
+
+The difference between the two strategies:
+For example, if the input SQL is:
+```sql
+CREATE TABLE tb (id INT)
+
+SELECT
+```
+In the `SqlSplitStrategy.STRICT` strategy, `isStatementBeginning` is `false`, because the CREATE statement is not terminated by a semicolon.
+
+In the `SqlSplitStrategy.LOOSE` strategy, `isStatementBeginning` is `true`, because the syntax parsing tree splits the SQL into two independent statements: CREATE and SELECT.
+
+You can set the strategy through the third `options` parameter:
+```typescript
+hive.getSemanticContextAtCaretPosition(sql, pos, { splitSqlStrategy: SqlSplitStrategy.LOOSE });
+```
+
 ### Other API
 
 - `createLexer` Create an instance of Antlr4 Lexer and return it;

package/dist/lib/flink/FlinkSqlLexer.d.ts

@@ -1,7 +1,7 @@
 import * as antlr from "antlr4ng";
 export declare class FlinkSqlLexer extends antlr.Lexer {
-    static readonly SPACE = 1;
-    static readonly COMMENT_INPUT = 2;
+    static readonly WHITE_SPACE = 1;
+    static readonly BRACKETED_COMMENT = 2;
     static readonly LINE_COMMENT = 3;
     static readonly KW_ABS = 4;
     static readonly KW_ALL = 5;
@@ -529,11 +529,11 @@ export declare class FlinkSqlLexer extends antlr.Lexer {
     static readonly COLON_SYMB = 527;
     static readonly ASTERISK_SIGN = 528;
     static readonly UNDERLINE_SIGN = 529;
-    static readonly HYPNEN_SIGN = 530;
+    static readonly HYPHEN_SIGN = 530;
     static readonly ADD_SIGN = 531;
-    static readonly PENCENT_SIGN = 532;
+    static readonly PERCENT_SIGN = 532;
     static readonly DOUBLE_VERTICAL_SIGN = 533;
-    static readonly DOUBLE_HYPNEN_SIGN = 534;
+    static readonly DOUBLE_HYPHEN_SIGN = 534;
     static readonly SLASH_SIGN = 535;
     static readonly QUESTION_MARK_SIGN = 536;
     static readonly DOUBLE_RIGHT_ARROW = 537;