packagek-kinzal/sql-parser

README§

SQL Parser

License: MIT Docs PHP Version Ask DeepWiki

SQL Parser is a set of LALR(1) parsers for MySQL, PostgreSQL, and SQLite written in PHP. Each parser is generated from the official grammar of a server version (sql_yacc.yy for MySQL, gram.y for PostgreSQL, and parse.y for SQLite), and its lexer is a port of the server's own scanner, so text is tokenized and parsed the way the server does it. The syntax tree names the nonterminals of the upstream grammar, and parsing is lossless: a tree writes back the text it was parsed from, byte for byte, including comments and whitespace.

Requirements

• PHP 8.1+ with the zlib extension

Support Syntax

The following grammar versions are bundled. Pass the version tag to the parser; omitting it uses the default for that database.

MySQL

PostgreSQL

SQLite

Installation

composer require k-kinzal/sql-parser

Usage

use SqlParser\MySql\MySqlParser;

$parser = new MySqlParser('mysql-8.4.7');
$sql = 'SELECT id, name FROM users u WHERE u.id = ? ORDER BY id LIMIT 10';
$tree = $parser->parse($sql);

$tree->name;                                     // 'start_entry', the grammar's start symbol
$tree->find('where_clause')[0]->text($sql);      // 'WHERE u.id = ?'
$tree->find('table_reference')[0]->text($sql);   // 'users u'
$tree->toString();                               // the statement again, byte for byte

License

MIT License. See LICENSE for details.