classPgSqlQueryGuard

packages/ztd-query-postgres/src/Rewrite/PgSqlQueryGuard.php:22

final class PgSqlQueryGuard

Public API: explicitly declared with @visibility public.

Classifies PostgreSQL SQL statements into QueryKind categories.

Route reads, simulated writes and transactionsdoctest

$guard = new \ZtdQuery\Platform\Postgres\Rewrite\PgSqlQueryGuard(new \ZtdQuery\Platform\Postgres\Sql\PgSqlParser());
    $guard->classify('SELECT 1') === \ZtdQuery\Rewrite\QueryKind::READ // => true
    $guard->classify('DELETE FROM users') === \ZtdQuery\Rewrite\QueryKind::WRITE_SIMULATED // => true
    $guard->classify('BEGIN') === \ZtdQuery\Rewrite\QueryKind::SKIPPED // => true
    $guard->classify('VACUUM') // => null

Methods§

public function __construct(PgSqlParser $parser)

source §

Initializes the collaborators and state used by this query guard.

Parameters

$parser PgSqlParser

public function classify(string $sql): ?QueryKind

source §

Public API: explicitly declared with @visibility public.

Classify a SQL string into READ/WRITE_SIMULATED/DDL_SIMULATED/SKIPPED or null.

Parameters

$sql string

Returns

?QueryKind

Route reads, simulated writes and transactionsdoctest

$guard = new \ZtdQuery\Platform\Postgres\Rewrite\PgSqlQueryGuard(new \ZtdQuery\Platform\Postgres\Sql\PgSqlParser());
    $guard->classify('SELECT 1') === \ZtdQuery\Rewrite\QueryKind::READ // => true
    $guard->classify('DELETE FROM users') === \ZtdQuery\Rewrite\QueryKind::WRITE_SIMULATED // => true
    $guard->classify('BEGIN') === \ZtdQuery\Rewrite\QueryKind::SKIPPED // => true
    $guard->classify('VACUUM') // => null