sql parser

sql parser

Un lexer et un analyseur SQL de validation axés sur le dialecte MySQL.

Statut des codes

Installation

Veuillez utiliser Composer pour installer :

composer require phpmyadmin/sql-parser

Documentation

La documentation de l'API est disponible sur https://develdocs.phpmyadmin.net/sql-parser/.

Usage

Utilitaires de ligne de commande

Utilitaire de ligne de commande pour mettre en évidence la syntaxe d'une requête SQL :

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

Utilitaire de ligne de commande pour lint une requête SQL :

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

Utilitaire de ligne de commande pour tokeniser la requête SQL :

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

Toutes les commandes sont capables d'analyser les entrées de stdin (standard in), telles que :

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

Formatage d'une requête SQL

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

Type de requête de découverte

 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;

Analyser et créer une requête 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(PhpMyAdminSqlParserStatementsSelectStatement)

// 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(PhpMyAdminSqlParserStatementsSelectStatement) 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" ' 

Localisation

Vous pouvez localiser les messages d'erreur en installant phpmyadmin/motranslator version 5.0 ou plus récente :

composer require phpmyadmin/motranslator:^5.0

Les paramètres régionaux sont automatiquement détectés à partir de votre environnement, vous pouvez également définir un paramètre régional différent

De cli :

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

Depuis php :

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

PhpMyAdmin  SqlParser Translator:: setLocale ( ' pl ' );

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

Plus d'informations

Cette bibliothèque a été initialement créée lors du Google Summer of Code 2015 et est utilisée par phpMyAdmin depuis la version 4.5.