README

一个专注于MySQL语法的验证SQL词法分析和解析器。

代码状态

安装

请使用 Composer 进行安装

composer require phpmyadmin/sql-parser

文档

API 文档可在 https://develdocs.phpmyadmin.net/sql-parser/ 查找。

使用方法

命令行工具

用于语法高亮SQL查询的命令行工具

./vendor/bin/highlight-query --query "SELECT 1"

用于检查SQL查询错误的命令行工具

./vendor/bin/lint-query --query "SELECT 1"

用于标记SQL查询的命令行工具

./vendor/bin/tokenize-query --query "SELECT 1"

所有命令都可以从stdin（标准输入）解析输入，例如

echo "SELECT 1" | ./vendor/bin/highlight-query
cat example.sql | ./vendor/bin/lint-query

格式化SQL查询

echo PhpMyAdmin\SqlParser\Utils\Formatter::format($query, ['type' => 'html']);

发现查询类型

use PhpMyAdmin\SqlParser\Parser;
use PhpMyAdmin\SqlParser\Utils\Query;

$query = 'OPTIMIZE TABLE tbl';
$parser = new Parser($query);
$flags = Query::getFlags($parser->statements[0]);

echo $flags->queryType?->value;

解析和构建SQL查询

require __DIR__ . '/vendor/autoload.php';

$query1 = 'select * from a';
$parser = new PhpMyAdmin\SqlParser\Parser($query1);

// inspect query
var_dump($parser->statements[0]); // outputs object(PhpMyAdmin\SqlParser\Statements\SelectStatement)

// modify query by replacing table a with table b
$table2 = new \PhpMyAdmin\SqlParser\Components\Expression('', 'b', '', '');
$parser->statements[0]->from[0] = $table2;

// build query again from an array of object(PhpMyAdmin\SqlParser\Statements\SelectStatement) to a string
$statement = $parser->statements[0];
$query2 = $statement->build();
var_dump($query2); // outputs string(19) 'SELECT  * FROM `b` '

// Change SQL mode
PhpMyAdmin\SqlParser\Context::setMode(PhpMyAdmin\SqlParser\Context::SQL_MODE_ANSI_QUOTES);

// build the query again using different quotes
$query2 = $statement->build();
var_dump($query2); // outputs string(19) 'SELECT  * FROM "b" '

本地化

您可以通过安装 phpmyadmin/motranslator 版本 5.0 或更高版本来本地化错误消息

composer require phpmyadmin/motranslator:^5.0

区域设置会自动从您的环境中检测到，您也可以设置不同的区域设置

从命令行:

LC_ALL=pl ./vendor/bin/lint-query --query "SELECT 1"

从PHP:

require __DIR__ . '/vendor/autoload.php';

$GLOBALS['lang'] = 'pl';

$query1 = 'select * from a';
$parser = new PhpMyAdmin\SqlParser\Parser($query1);

更多信息

此库最初是在2015年Google Summer of Code期间创建的，并自phpMyAdmin版本4.5以来一直被使用。