phpmyadmin/sql-parser

A validating SQL lexer and parser with a focus on MySQL dialect.

5.10.1 2024-11-10 04:10 UTC

Requires

• php: ^7.2 || ^8.0
• symfony/polyfill-mbstring: ^1.3
• symfony/polyfill-php80: ^1.16

Requires (Dev)

• phpbench/phpbench: ^1.1
• phpmyadmin/coding-standard: ^3.0
• phpmyadmin/motranslator: ^4.0 || ^5.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.9.12
• phpstan/phpstan-phpunit: ^1.3.3
• phpunit/phpunit: ^8.5 || ^9.6
• psalm/plugin-phpunit: ^0.16.1
• vimeo/psalm: ^4.11
• zumba/json-serializer: ~3.0.2

Suggests

• ext-mbstring: For best performance
• phpmyadmin/motranslator: Translate messages to your favorite locale

Conflicts

• phpmyadmin/motranslator: <3.0

GPL-2.0-or-later

• The phpMyAdmin Team

• sql
• parser
• lexer
• analysis
• sql syntax highlighter
• sql lexer
• sql tokenizer
• sql parser
• sql linter
• query linter

README

A validating SQL lexer and parser with a focus on MySQL dialect.

Code status

Installation

Please use Composer to install:

composer require phpmyadmin/sql-parser

Documentation

The API documentation is available at https://develdocs.phpmyadmin.net/sql-parser/.

Usage

Command line utilities

Command line utility to syntax highlight SQL query:

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

Command line utility to lint SQL query:

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

Command line utility to tokenize SQL query:

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

All commands are able to parse input from stdin (standard in), such as:

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

Formatting SQL query

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

Discoverying query type

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;

Parsing and building SQL query

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" '

Localization

You can localize error messages installing phpmyadmin/motranslator version 5.0 or newer:

composer require phpmyadmin/motranslator:^5.0

The locale is automatically detected from your environment, you can also set a different locale

From cli:

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

From php:

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

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

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

More information

This library was originally created during the Google Summer of Code 2015 and has been used by phpMyAdmin since version 4.5.