dt-sql-parser 4.0.0-beta.4.5 → 4.0.0-beta.4.6

package/README.md

@@ -13,9 +13,9 @@ English | [简体中文](./README-zh_CN.md)
 [online-chat-img]: https://img.shields.io/discord/920616811261743104?logo=Molecule
 [online-chat-url]: https://discord.gg/uVvq6mfPfa
 
-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.
+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.
 
-Additionally, it provides auxiliary functions such as SQL splitting and Auto-Complete.
+Additionally, it provides auxiliary functions such as **SQL splitting** and **code completion**.
 
 **Supported SQL**:
 
@@ -29,15 +29,15 @@ Additionally, it provides auxiliary functions such as SQL splitting and Auto-Com
 
 **Supported auxiliary methods**
 
-| SQL Type    | SQL Split | Code-Completion |
-| ----------- | --------  | -------- |
-| Generic SQL | WIP       | WIP      |
-| Flink SQL   | ✅        | ✅       |
-| Spark SQL   | ✅        | ✅       |
-| Hive SQL    | ✅        | ✅       |
-| PL/SQL      | WIP       | WIP      |
-| Postgre SQL | WIP       | WIP      |
-| Trino SQL   | ✅        | ✅       |
+| SQL Type    | SQL Spliting | Code Completion |
+| ----------- | ------------ | --------------- |
+| Generic SQL | WIP          | WIP             |
+| Flink SQL   | ✅           | ✅              |
+| Spark SQL   | ✅           | ✅              |
+| Hive SQL    | ✅           | ✅              |
+| PL/SQL      | WIP          | WIP            |
+| PostgreSQL  | ✅           | ✅              |
+| Trino SQL   | ✅           | ✅              |
 
 >Tips: This project is the default for Javascript language, also you can try to compile it to other languages if you need.
 
@@ -68,13 +68,13 @@ We recommend learning the Fundamentals usage before continuing. The dt-sql-parse
 import { GenericSQL, FlinkSQL, SparkSQL, HiveSQL, PLSQL, PostgresSQL, TrinoSQL } from 'dt-sql-parser';
 ```
 
-Before employing syntax validation, code completion, and other features, it is necessary to instantiate the Parser of the relevant SQL type.
+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 `GenericSQL` as an example:
 ```javascript
 const parser = new GenericSQL();
 ```
 
-The following usage examples will utilize the `GenericSQL`, and the Parser for other SQL types will be employed in a similar manner as `GenericSQL`.
+The following usage examples will utilize the `GenericSQL`, and the Parser for other SQL types will be used in a similar manner as `GenericSQL`.
 
 ### Syntax Validation
 ```javascript
@@ -256,10 +256,10 @@ console.log(sqlSlices)
 ```
 
 ### Code Completion
-Obtaining autocomplete information at a specified position in SQL.
+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 auto-completion is desired.
+Invoke the `getSuggestionAtCaretPosition` method, pass the SQL content and the row and column numbers indicating the position where code completion is desired.
 + keyword candidates list
 
     ```javascript
@@ -313,7 +313,7 @@ Invoke the `getSuggestionAtCaretPosition` method, pass the SQL content and the r
     ]
     */
     ```
-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.
+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.
 
 ### Other API