sqlftw下载sqlftw源代码下载

sqlftw

其他类别

v0.1.16

下载

sqlftw

MySQL（目前）Lexer，解析器，语言模型和静态分析仪，用PHP编写

它是一个验证解析器，可为大约140个支持的SQL命令中的每一个中的每个实现对象实现对象。命令确实对SQL代码的句法方面进行建模，而不是域的方面（完全编写查询的模型），但是没有跟踪空白，目前忽略了一些注释

该解析器旨在作为其他两个项目的基础：

一种是对SQL代码进行静态分析，尤其是迁移的安全性和性能（目前使用PHPMYADMIN项目的非常基本的SQL解析器）
有望帮助Phpstan（PHP的静态分析工具）更好地了解SQL查询及其结果

它本身可用于验证SQL代码的语法（例如迁移）

SQL语法支持：

支持从MySQL 5.X到MySQL 8.0.34的所有SQL命令以及几乎所有语言功能

不支持的功能将无法解析：

支持ASCII不兼容的多型编码，例如shift-jis ， gb18030或utf-16 （未能解析）
引用定界符（未实施，可能会失败）
在ANSI模式下双重引用名称的隐式字符串串联（ "foo" "bar" ；这是在字符串上支持的，但在名称上不支持）

接受但忽略了功能（没有模型和序列化）：

在表达式中解决操作员优先级（目前，同一层的运营商仅从左到右解析；将在稍后实施）
语句中的定期评论（收集语句之前的评论）
Heatwave插件功能（Secondary_engine）
SELECT ... PROCEDURE ANALYSE (...) - 在MySQL 8中删除
WEIGHT_STRING(... LEVEL ...) - 在MySQL 8中删除

除MySQL以外的方式实现了功能：

解析器在与PostgreSQL相同的未终止注释上产生错误（MySQL是无声的，并且根据测试，这可能是一个错误）
解析器以无效的名称读取用户变量时会产生错误（MySQL默默地忽略它们并返回null）
解析器在使用无效的语法上产生了优化器提示的错误（MySQL会产生警告，AWS Aurora mysql a错误）

建筑学：

主层：

Lexer-令牌SQL，返回一个解析器令牌的发电机
解析器（S） - 验证语法并返回解析命令对象的生成器
命令 - SQL命令从明文到不变的对象表示。可以序列化回到明文
平台 - 特定平台支持的功能列表
格式化 - 可配置的SQL语句序列化器
分析仪 - 静态分析规则和仪器

基本用法：

 <?php

use ...

$platform = Platform::get(Platform::MYSQL, '8.0'); // version defaults to x.x.99 when no patch number is given
$config = new ParserConfig($platform);
$session = new Session($platform);
$parser = new Parser($config, $session);

// returns a Generator. will not parse anything if you don't iterate over it
$commands = $parser->parse('SELECT foo FROM ...');
foreach ($commands as $command) {
    // Parser does not throw exceptions. this allows to parse partially invalid code and not fail on first error
    if ($command instanceof InvalidCommand) {
        $e = $command->getException();
        ...
    }
    ...
}

当前的发展状态：

我们现在在哪里：

☑〜99.9％MySQL语言功能已实现
☑序列化基本单元测试
☑针对数千个表和迁移进行了测试
☑几乎解析了MySQL测试套件（没有假否定的）的几乎所有内容
☑几乎所有来自MySQL测试套件的错误测试失败（无误报）
☑MySQL测试套件上的序列化测试（所有SQL特征如预期表示）
☐针对MySQL测试套件的多个版本的平行和自动测试
☐突变测试（处理突变的SQL与真实DB相同；超出MySQL测试套件的扩展范围）
☐区分平台版本（DB服务器的精确补丁版本解析）
☐将我的迁移静态分析工具移植到此库
☐发布第一个稳定版本？
☐其他平台（Mariadb，Sqlite，PostgreSql ...）

版本控制：

我们都喜欢语义版本，不是吗？：]]

但是，这个图书馆是一项巨大的任务，仍在迅速的初始开发阶段。即使在此阶段，我也决定标记和发布版本，因为我认为它总比没有好，而且比发布数十个alpha版本更好。因此，在我们离开“ 0.1”之前，不要期望任何向后兼容性。在第一次尝试上设计巨大的系统是不可能的，许多概念必须安顿下来并单击其位置，因此仍在进行许多更改

使用作曲家时，请始终将您对此软件包的依赖性锁定到精确版本。例如sqlftw/sqlftw:0.1.14