interfaceSqlParser

packages/sql-parser/src/Parser/SqlParser.php:20

interface SqlParser

Public API: explicitly declared with @visibility public.

A lossless SQL parser configured for a grammar release and lexical settings.

Consumers depend on this contract instead of enumerating concrete parsers.

Declare a consumer of the parsing contractdoctest

$roundTrip = static fn (\SqlParser\Parser\SqlParser $parser, string $sql): string => $parser->parse($sql)->toString();
    $roundTrip instanceof \Closure // => true

Methods§

public function version(): string

source §

Returns the configured grammar release tag.

Returns

string

Test cases 1

SqlParserTest::testVersionIdentifiesTheConfiguredRelease calls

Called from 1

method-call SqlSemantics\Core\Ast\DialectParser::version() packages/sql-semantics/src/Core/Ast/DialectParser.php:82

public function tokenize(string $sql): list<Token>

source §

Reads terminals, including their leading trivia and the end marker.

Parameters

$sql string

Returns

list<Token>

Throws

SourceException When the text cannot be tokenized

Test cases 1

SqlParserTest::testTokenizePreservesSourceThroughTheContract calls

Called from 3

public function parse(string $sql): Node

source §

Reads a concrete syntax tree that preserves every byte of the input.

Parameters

$sql string

Returns

Node

Throws

SourceException When the text is not accepted by the grammar

Test cases 1

SqlParserTest::testParsePreservesSourceThroughTheContract calls

Called from 5

Test cases 8§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 3

Other tests reaching this symbol 5

Relations§

Implemented by 3

Method calls 9

Type declarations 10