lava-oushudb-dt-sql-parser/README-zh_CN.md

dt-sql-parser

English | 简体中文

dt-sql-parser 是一个基于 ANTLR4 开发的， 针对大数据领域的 SQL Parser 项目。通过ANTLR4 生成的 Parser、Visitor 和 Listener，我们可以轻松的做到对 SQL 语句的语法检查（Syntax Validation）、词法分析（Tokenizer)、 遍历 AST 节点等功能。此外，还提供了一些辅助方法, 例如 SQL 切割（Split）、自动补全等。

已支持的 SQL 类型：

• MySQL
• Flink SQL
• Spark SQL
• Hive SQL
• PostgreSQL
• Trino SQL
• Impala SQL

SQL 辅助方法支持

SQL 类型	SQL 切割	自动补全
MySQL	✅	✅
Flink SQL	✅	✅
Spark SQL	✅	✅
Hive SQL	✅	✅
PostgreSQL	✅	✅
Trino SQL	✅	✅
Impala SQL	✅	✅

提示：当前的 Parser 是 Javascript 语言版本，如果有必要，可以尝试编译 Grammar 文件到其他目标语言。

与 MonacoEditor 集成

我们提供了monaco-sql-languages，通过它你可以轻易的将dt-sql-parser与monaco-editor集成。

安装

# use npm
npm i dt-sql-parser --save

# use yarn
yarn add dt-sql-parser

使用

在开始使用前，需要先了解基本用法。dt-sql-parser 为不同类型的 SQL 分别提供相应的 SQL Parser 类：

import { MySQL, FlinkSQL, SparkSQL, HiveSQL, PostgresSQL, TrinoSQL, ImpalaSQL } from 'dt-sql-parser';

在使用语法校验，自动补全等功能之前，需要先实例化对应 SQL 类型的 Parser，以 MySQL 为例：

const parser = new MySQL();

下文中的使用示例将使用 MySQL，其他 SQL 类型的 Parser 使用方式与MySQL 相同。

语法校验（Syntax Validation）

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); 

输出：

/*
[]
*/

校验失败示例：

const incorrectSql = 'selec id,name from user1;'
const errors = parser.validate(incorrectSql);
console.log(errors); 

输出：

/*
[
  {
    endCol: 5,
    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', '--', '(', ';'}"
  }
]
*/

先实例化 Parser 对象，然后使用 validate 方法对 SQL 语句进行校验，如果校验失败，则返回一个包含 error 信息的数组。

词法分析（Tokenizer）

部分场景下，可以通过 getAllTokens 单独对 SQL 语句进行词法分析，获取所有的 Tokens 对象：

import { MySQL } from 'dt-sql-parser';

const parser = new MySQL()
const sql = 'select id,name,sex from user1;'
const tokens = parser.getAllTokens(sql)
console.log(tokens)

输出：

/*
[
  {
    channel: 0
    column: 0
    line: 1
    source: [SqlLexer, InputStream]
    start: 0
    stop: 5
    tokenIndex: -1
    type: 137
    _text: null
  },
  ...
]
*/

访问者模式（Visitor）

使用 Visitor 模式访问 AST 中的指定节点

import { MySQL, MySqlParserVisitor } from 'dt-sql-parser';

const parser = new MySQL()
const sql = `select id,name from user1;`
// parseTree
const tree = parser.parse(sql)
class MyVisitor extends MySqlParserVisitor {
    // 重写 visitTableName 方法
    visitTableName(ctx) {
        let tableName = ctx.getText().toLowerCase()
        console.log('TableName', tableName)
    }
    // 重写 visitSelectElements 方法
    visitSelectElements(ctx) {
        let selectElements = ctx.getText().toLowerCase()
        console.log('SelectElements', selectElements)
    }
}
const visitor = new MyVisitor()
visitor.visit(tree)

输出：

/*
SelectElements id,name
TableName user1
*/

提示：使用 Visitor 模式时，节点的方法名称可以在对应 SQL 目录下的 Visitor 文件中查找

监听器（Listener）

Listener 模式，利用 ANTLR4 提供的 ParseTreeWalker 对象遍历 AST，进入各个节点时调用对应的方法。

import { MySQL, MySqlParserListener } from 'dt-sql-parser';

const parser = new MySQL();
const sql = 'select id,name from user1;'
// parseTree
const tree = parser.parse(sql)
class MyListener extends MySqlParserListener {
    enterTableName(ctx) {
        let tableName = ctx.getText().toLowerCase()
        console.log('TableName', tableName)
    }
    enterSelectElements(ctx) {
        let selectElements = ctx.getText().toLowerCase()
        log('SelectElements', selectElements)
    }
}
const listenTableName = new MyListener();
parser.listen(listenTableName, tree);

输出：

/*
SelectElements id,name
TableName user1
*/

提示：使用 Listener 模式时，节点的方法名称可以在对应 SQL 目录下的 Listener 文件中查找

SQL 按语句切割

以 FlinkSQL 为例：

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)

输出：

/*
[
  {
    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;'
  }
]
*/

自动补全（Code Completion）

在 sql 文本的指定位置上获取自动补全信息，以 FlinkSQL 为例：

调用 getSuggestionAtCaretPosition 方法，传入 sql 内容和指定位置的行列号。

• 获取关键字候选项列表

  import { FlinkSQL } from 'dt-sql-parser';
  const parser = new FlinkSQL();
  const sql = 'CREATE ';
  const pos = { lineNumber: 1, column: 16 }; // 最后一个位置
  const keywords = parser.getSuggestionAtCaretPosition(sql, pos)?.keywords;
  console.log(keywords);
  

  输出：

  /*
  [ 'CATALOG', 'FUNCTION', 'TEMPORARY', 'VIEW', 'DATABASE', 'TABLE' ] 
  */ 
  

• 获取语法相关自动补全信息

  const parser = new FlinkSQL();
  const sql = 'SELECT * FROM tb';
  const pos = { lineNumber: 1, column: 16 }; // 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
        }
      ]
    }
  ]
  */
  

语法相关自动补全信息返回一个数组，数组中每一项代表该位置可以填写什么语法，比如上例中的输出结果代表该位置可以填写表名或者视图名称。其中 syntaxContextType 是可以补全的语法类型，wordRanges 是已经填写的内容。

其他 API

• createLexer 创建一个 Antlr4 Lexer 实例并返回；
• createParser 创建一个 Antlr4 Parser 实例并返回；
• parse 解析输入的 sql，并返回解析树；

许可证

MIT