classSqliteRewriter

packages/ztd-query-sqlite/src/Rewrite/SqliteRewriter.php:35

final class SqliteRewriter
    implements SqlRewriter, RewriteStateCommitter

Public API: explicitly declared with @visibility public.

SQLite rewrite implementation for ZTD.

Orchestrates parsing, classification, transformation, and mutation resolution. Uses Result Select Query approach (not RETURNING) for consistency.

Compose a SQLite rewriter with caller-owned statedoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $rewriter->rewrite('SELECT 1')->sql() // => 'SELECT 1'

Methods§

public function transactionStatement(string $sql): ?TransactionStatement

source §

Public API: explicitly declared with @visibility public.

Returns transaction statement.

Parameters

$sql string

Returns

?TransactionStatement

Recognize transaction commands independently of query classificationdoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $rewriter->transactionStatement('BEGIN') instanceof \ZtdQuery\Sql\TransactionStatement // => true
    $rewriter->transactionStatement('SELECT 1') // => null

Test cases 1

SqliteRewriterTest::testTransactionStatementRestoresSnapshotOnRollback calls

Calls 2

method-call SqliteTransactionStatementParser::parse() line 53
new SqliteTransactionStatementParser line 53

public function __construct(
    SqliteQueryGuard $guard,
    ShadowStore $shadowStore,
    TableDefinitionRegistry $registry,
    SqliteTransformer $transformer,
    SqliteMutationResolver $mutationResolver,
    SqliteParser $parser,
    ?ViewDefinitionSet $views = null,
)

source §

Public API: explicitly declared with @visibility public.

Binds the dependencies used by this operation.

Parameters

`$guard`	`SqliteQueryGuard`
`$shadowStore`	`ShadowStore`
`$registry`	`TableDefinitionRegistry`
`$transformer`	`SqliteTransformer`
`$mutationResolver`	`SqliteMutationResolver`
`$parser`	`SqliteParser`
`$views`	`?ViewDefinitionSet`

Bind schema, shadow data and transformersdoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $rewriter->rewrite('SELECT 1')->kind() // => \ZtdQuery\Rewrite\QueryKind::READ

Calls 3

new SqliteReturningProjectionParser line 94
new SqliteCteShadowComposer line 95
new ViewDefinitionSet line 96

public function rewrite(string $sql): RewritePlan

source §

Public API: explicitly declared with @visibility public.

{@inheritDoc}

Parameters

$sql string

Returns

RewritePlan

Throws

UnsupportedSqlException When SQL is empty, unparseable, or multi-statement.

UnknownSchemaException When SQL references unknown tables/columns.

Reject multiple statements on the single-statement APIdoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $rewriter->rewrite('SELECT 1; SELECT 2') // throws \ZtdQuery\Exception\UnsupportedSqlException: Multi-statement

Test cases 79

Calls 5

method-call SqliteParser::splitStatements() line 117
new UnsupportedSqlException line 119
function-call count line 122
method-call StatementRewriter::rewriteStatement() line 123
new StatementRewriter line 123

public function rewriteMultiple(string $sql): MultiRewritePlan

source §

Public API: explicitly declared with @visibility public.

{@inheritDoc}

Parameters

$sql string

Returns

MultiRewritePlan

Throws

UnsupportedSqlException When SQL is empty or unparseable.

UnknownSchemaException When SQL references unknown tables/columns.

Produce an ordered multi-statement plandoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $plans = $rewriter->rewriteMultiple('SELECT 1; SELECT 2');
    $plans->count() // => 2
    $plans->get(1)?->sql() // => 'SELECT 2'

Test cases 2

Calls 5

method-call SqliteRewriter::splitStatements() line 149
new UnsupportedSqlException line 152
method-call StatementRewriter::rewriteStatement() line 157
new StatementRewriter line 157
new MultiRewritePlan line 160

public function splitStatements(string $sql): array

source §

Public API: explicitly declared with @visibility public.

{@inheritDoc}

Parameters

$sql string

Returns

array

Split statements while preserving quoted semicolonsdoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $rewriter->splitStatements("SELECT ';'; SELECT 2") // => ["SELECT ';'", 'SELECT 2']

Test cases 1

SqliteRewriterTest::testSplitStatementsPreservesQuotedSemicolons calls

Called from 1

method-call ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter::rewriteMultiple() packages/ztd-query-sqlite/src/Rewrite/SqliteRewriter.php:149

Calls 1

method-call SqliteParser::splitStatements() line 178

public function commitRewriteState(): void

source §

Public API: explicitly declared with @visibility public.

Commits the transformer state after a rewrite completes.

Commit rewrite state after executiondoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $rewriter->rewrite('SELECT 1');
    $rewriter->commitRewriteState();
    $rewriter->rewrite('SELECT 2')->sql() // => 'SELECT 2'

Test cases 2

Calls 1

method-call SqliteTransformer::commitRewriteState() line 198

public function emptyResultSelect(): string

source §

Public API: explicitly declared with @visibility public.

Returns a SELECT that produces no result rows.

Returns

string

Produce a SELECT with no rowsdoctest

$parser = new \ZtdQuery\Platform\Sqlite\Sql\SqliteParser();
    $store = new \ZtdQuery\Shadow\ShadowStore();
    $registry = new \ZtdQuery\Schema\TableDefinitionRegistry();
    $select = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SelectTransformer();
    $transformer = new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\SqliteTransformer($parser, $select, new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\InsertTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\UpdateTransformer($parser, $select), new \ZtdQuery\Platform\Sqlite\Rewrite\Transformer\DeleteTransformer($parser, $select));
    $resolver = new \ZtdQuery\Platform\Sqlite\Shadow\SqliteMutationResolver($store, $registry, new \ZtdQuery\Platform\Sqlite\Schema\SqliteSchemaParser(), $parser);
    $rewriter = new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteRewriter(new \ZtdQuery\Platform\Sqlite\Rewrite\SqliteQueryGuard($parser), $store, $registry, $transformer, $resolver, $parser);
    $sql = $rewriter->emptyResultSelect();
    $pdo = new \PDO('sqlite::memory:');
    $pdo->query($sql)->fetchAll() // => []

Test cases 1

SqliteRewriterTest::testEmptyResultSelectProducesNoRows calls

Private surface 9§

Implementation details, listed for orientation only.

private SqliteQueryGuard $guard

private ShadowStore $shadowStore

private TableDefinitionRegistry $registry

private SqliteTransformer $transformer

private SqliteMutationResolver $mutationResolver

private SqliteParser $parser

private SqliteReturningProjectionParser $returningProjectionParser

private SqliteCteShadowComposer $cteComposer

private ViewDefinitionSet $views

Test cases 87§

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

Dedicated tests 80

Other tests reaching this symbol 7

RewriterBench::benchRewriteInsert calls
RewriterBench::benchRewriteSelect calls
RewriterBench::setUp calls
RewriteCheck::verify calls
RewriteTarget::__invoke calls
SemanticsTarget::__invoke calls
SqliteSessionFactoryTest calls

Relations§

Instantiated in 1

new ZtdQuery\Platform\Sqlite\SqliteSessionFactory::create() packages/ztd-query-sqlite/src/SqliteSessionFactory.php:68