Sentinel-based deferred identifier quoting

simon-mundy · simon-mundy · commit cfb7bd498278 · 2026-03-04T23:32:43.000+11:00
Replace per-identifier platform-&gt;quoteIdentifier() calls with sentinel
bytes (\x01 open, \x02 close) during rendering, converted to real quote
characters via a single strtr() at the SQL output boundary.

- Pre-compute sentinel-wrapped identifier on Identifier::$qi at construction
- Remove $identifier[] cache from AbstractSqlRenderer
- Sentinel-wrap in renderTableSource, renderResolvedTable, renderIdentifiersIn
- Use $column-&gt;qi directly in Columns, OrderBy, GroupBy, Set, Insert parts
- Add $quoteChars property probed from platform in init()
- Apply strtr at all 4 boundary entry points (getSqlString, prepareStatement,
  Sql::buildSqlString, Sql::prepareStatementForSqlObject) plus render()
  and processSubSelect
diff --git a/src/Sql/AbstractPreparableSql.php b/src/Sql/AbstractPreparableSql.php
@@ -8,8 +8,11 @@
 use PhpDb\Adapter\AdapterInterface;
 use PhpDb\Adapter\ParameterContainer;
 use PhpDb\Adapter\StatementContainerInterface;
+use PhpDb\Sql\Platform\AbstractSqlRenderer;
 use PhpDb\Sql\Platform\Sql92Renderer;
 
+use function strtr;
+
 abstract class AbstractPreparableSql extends AbstractSql implements PreparableSqlInterface
 {
     #[Override]
@@ -25,9 +28,17 @@ public function prepareStatement(
             $statementContainer->setParameterContainer($parameterContainer);
         }
 
+        $renderer = (new Sql92Renderer())->init(
+            $adapter->getPlatform(),
+            $adapter->getDriver(),
+            $parameterContainer
+        );
+
         $statementContainer->setSql(
-            $this->buildSqlString(
-                (new Sql92Renderer())->init($adapter->getPlatform(), $adapter->getDriver(), $parameterContainer)
+            strtr(
+                $this->buildSqlString($renderer),
+                AbstractSqlRenderer::QI_PAIR,
+                $renderer->quoteChars
             )
         );
 
diff --git a/src/Sql/AbstractSql.php b/src/Sql/AbstractSql.php
@@ -10,6 +10,8 @@
 use PhpDb\Sql\Platform\AbstractSqlRenderer;
 use PhpDb\Sql\Platform\Sql92Renderer;
 
+use function strtr;
+
 abstract class AbstractSql implements SqlInterface
 {
     private ?AbstractSqlRenderer $renderer = null;
@@ -22,8 +24,12 @@ public function getSqlString(?PlatformInterface $adapterPlatform = null): string
     {
         $this->renderer ??= new Sql92Renderer();
 
-        return $this->buildSqlString(
-            $this->renderer->init($adapterPlatform ?? new DefaultAdapterPlatform())
+        $renderer = $this->renderer->init($adapterPlatform ?? new DefaultAdapterPlatform());
+
+        return strtr(
+            $this->buildSqlString($renderer),
+            AbstractSqlRenderer::QI_PAIR,
+            $renderer->quoteChars
         );
     }
 
diff --git a/src/Sql/Argument/Identifier.php b/src/Sql/Argument/Identifier.php
@@ -6,12 +6,23 @@
 
 use PhpDb\Sql\ArgumentInterface;
 use PhpDb\Sql\ArgumentType;
+use PhpDb\Sql\Platform\AbstractSqlRenderer;
+
+use function str_contains;
+use function str_replace;
 
 final readonly class Identifier implements ArgumentInterface
 {
+    public string $qi;
+
     public function __construct(
         public string $identifier
     ) {
+        $this->qi = str_contains($identifier, '.')
+            ? AbstractSqlRenderer::QI_OPEN
+                . str_replace('.', AbstractSqlRenderer::QI_SEP, $identifier)
+                . AbstractSqlRenderer::QI_CLOSE
+            : AbstractSqlRenderer::QI_OPEN . $identifier . AbstractSqlRenderer::QI_CLOSE;
     }
 
     public function getType(): ArgumentType
diff --git a/src/Sql/Insert.php b/src/Sql/Insert.php
@@ -158,7 +158,7 @@ public function buildSqlString(AbstractSqlRenderer $renderer): string
             if ($columnNames !== []) {
                 $columns = [];
                 foreach ($columnNames as $col) {
-                    $columns[] = $renderer->identifier[$col] ??= $renderer->platform->quoteIdentifier($col);
+                    $columns[] = AbstractSqlRenderer::QI_OPEN . $col . AbstractSqlRenderer::QI_CLOSE;
                 }
                 return $keyword . ' ' . $tableSql
                     . ' (' . implode(', ', $columns) . ') ' . $selectSql;
@@ -178,7 +178,7 @@ public function buildSqlString(AbstractSqlRenderer $renderer): string
         $hasParamContainer = $renderer->parameterContainer instanceof ParameterContainer;
 
         foreach ($this->columns as $column => $value) {
-            $columns[] = $renderer->identifier[$column] ??= $renderer->platform->quoteIdentifier($column);
+            $columns[] = AbstractSqlRenderer::QI_OPEN . $column . AbstractSqlRenderer::QI_CLOSE;
 
             if ($value === null) {
                 $values[] = 'NULL';
diff --git a/src/Sql/Part/Columns.php b/src/Sql/Part/Columns.php
@@ -63,7 +63,6 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
         $fragments   = [];
         $exprCounter = 1;
         $pi          = 0;
-        $platform    = $renderer->platform;
         $refSets     = $this->joinRefs !== [] ? [$refs, $this->joinRefs] : [$refs];
 
         foreach ($refSets as $currentRefs) {
@@ -80,9 +79,7 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
                 $column = $ref->column;
 
                 if ($column instanceof Identifier) {
-                    $columnSql = $prefix
-                        . ($renderer->identifier[$column->identifier]
-                            ??= $platform->quoteIdentifier($column->identifier));
+                    $columnSql = $prefix . $column->qi;
                 } elseif ($column instanceof ArgumentInterface) {
                     $columnSql = $prefix . $renderer->renderArgument($column, '', $pi);
                 } else {
@@ -91,8 +88,7 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
 
                 if ($ref->columnAlias !== null) {
                     $fragments[] = $columnSql . ' AS '
-                        . ($renderer->identifier[$ref->columnAlias]
-                            ??= $platform->quoteIdentifier($ref->columnAlias));
+                        . AbstractSqlRenderer::QI_OPEN . $ref->columnAlias . AbstractSqlRenderer::QI_CLOSE;
                 } elseif ($ref->containsAlias) {
                     $fragments[] = $columnSql;
                 } else {
diff --git a/src/Sql/Part/GroupBy.php b/src/Sql/Part/GroupBy.php
@@ -22,15 +22,13 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
             return null;
         }
 
-        $platform = $renderer->platform;
-        $groups   = [];
+        $groups = [];
 
         foreach ($this->group as $ref) {
             $column = $ref->column;
 
             if ($column instanceof Identifier) {
-                $id       = $column->identifier;
-                $groups[] = $renderer->identifier[$id] ??= $platform->quoteIdentifier($id);
+                $groups[] = $column->qi;
             } elseif ($column instanceof ArgumentInterface) {
                 $pi       = 0;
                 $groups[] = $renderer->renderArgument($column, '', $pi);
diff --git a/src/Sql/Part/InsertSelect.php b/src/Sql/Part/InsertSelect.php
@@ -34,7 +34,7 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
 
         $columns = [];
         foreach (array_keys($this->columns) as $name) {
-            $columns[] = $renderer->identifier[$name] ??= $renderer->platform->quoteIdentifier($name);
+            $columns[] = AbstractSqlRenderer::QI_OPEN . $name . AbstractSqlRenderer::QI_CLOSE;
         }
         $columnsSql = implode(', ', $columns);
 
diff --git a/src/Sql/Part/InsertValues.php b/src/Sql/Part/InsertValues.php
@@ -48,7 +48,7 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
         $isPdoDriver = $renderer->driver instanceof PdoDriverInterface;
 
         foreach ($this->columnValues as $cv) {
-            $columns[] = $renderer->identifier[$cv->column] ??= $renderer->platform->quoteIdentifier($cv->column);
+            $columns[] = AbstractSqlRenderer::QI_OPEN . $cv->column . AbstractSqlRenderer::QI_CLOSE;
 
             $values[] = match ($cv->value->getType()) {
                 ArgumentType::Parameter => $renderer->bindParameter(
diff --git a/src/Sql/Part/OrderBy.php b/src/Sql/Part/OrderBy.php
@@ -31,16 +31,13 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
             return null;
         }
 
-        $platform = $renderer->platform;
-        $orders   = [];
+        $orders = [];
 
         foreach ($this->order as $spec) {
             $column = $spec->column;
 
             if ($column instanceof Identifier) {
-                $orders[] = ($renderer->identifier[$column->identifier]
-                    ??= $platform->quoteIdentifier($column->identifier))
-                    . ' ' . $spec->direction;
+                $orders[] = $column->qi . ' ' . $spec->direction;
             } elseif ($column instanceof ArgumentInterface) {
                 $pi       = 0;
                 $orders[] = $renderer->renderArgument($column, '', $pi)
diff --git a/src/Sql/Part/Set.php b/src/Sql/Part/Set.php
@@ -39,8 +39,7 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i
         $isPdoDriver = $renderer->driver instanceof PdoDriverInterface;
 
         foreach ($this->model as $column => $arg) {
-            $id     = $this->columnIds[$column]->identifier;
-            $prefix = ($renderer->identifier[$id] ??= $renderer->platform->quoteIdentifier($id)) . ' = ';
+            $prefix = $this->columnIds[$column]->qi . ' = ';
 
             $setSql[] = $prefix . match ($arg->getType()) {
                 ArgumentType::Parameter => $renderer->bindParameter(
diff --git a/src/Sql/Platform/AbstractSqlRenderer.php b/src/Sql/Platform/AbstractSqlRenderer.php
@@ -27,11 +27,17 @@
 use function preg_split;
 use function spl_object_id;
 use function str_replace;
+use function strtr;
 
 use const PREG_SPLIT_DELIM_CAPTURE;
 
 abstract class AbstractSqlRenderer
 {
+    public const QI_OPEN  = "\x01";
+    public const QI_CLOSE = "\x02";
+    public const QI_SEP   = "\x02.\x01";
+    public const QI_PAIR  = "\x01\x02";
+
     private const IDENTIFIER_PATTERN
         = '/\b(?!(?:AS|AND|OR|BETWEEN)\b)([a-zA-Z_]\w*+(?:\.[a-zA-Z_]\w*+)*)(?!\s*\()/i';
 
@@ -40,15 +46,14 @@ abstract class AbstractSqlRenderer
 
     public PlatformInterface $platform;
 
+    public string $quoteChars = '""';
+
     public ?DriverInterface $driver = null;
 
     public ?ParameterContainer $parameterContainer = null;
 
     private string $identifierSeparator = '.';
 
-    /** @var array<string, string> */
-    public array $identifier = [];
-
     /** @var array<int, string> */
     private array $tablePrefixCache = [];
 
@@ -69,8 +74,9 @@ public function init(
         if (! isset($this->platform) || $this->platform !== $platform) {
             $this->platform            = $platform;
             $this->identifierSeparator = $platform->getIdentifierSeparator();
+            $qi                        = $platform->quoteIdentifier('x');
+            $this->quoteChars          = $qi[0] . $qi[-1];
             $this->tablePrefixCache    = [];
-            $this->identifier          = [];
         }
 
         $this->driver                 = $driver;
@@ -122,19 +128,19 @@ public function renderTableSource(
 
         if ($table instanceof TableIdentifier) {
             $rendered = $table->schema === null
-                ? ($this->identifier[$table->table] ??= $this->platform->quoteIdentifier($table->table))
-                : $this->platform->quoteIdentifier(name: $table->table, prefix: $table->schema);
+                ? self::QI_OPEN . $table->table . self::QI_CLOSE
+                : self::QI_OPEN . $table->schema . self::QI_SEP . $table->table . self::QI_CLOSE;
         } elseif ($table instanceof Select) {
             $rendered = '(' . $this->processSubSelect($table) . ')';
         } elseif (is_string($table)) {
-            $rendered = $this->identifier[$table] ??= $this->platform->quoteIdentifier($table);
+            $rendered = self::QI_OPEN . str_replace('.', self::QI_SEP, $table) . self::QI_CLOSE;
         } else {
             $pi       = 0;
             $rendered = $table->toSql($this, '', $pi);
         }
 
         if ($alias !== null) {
-            $rendered .= ' AS ' . ($this->identifier[$alias] ??= $this->platform->quoteIdentifier($alias));
+            $rendered .= ' AS ' . self::QI_OPEN . $alias . self::QI_CLOSE;
         }
 
         return $rendered;
@@ -150,10 +156,12 @@ public function renderResolvedTable(
 
         if ($table instanceof TableIdentifier) {
             $prefix = $alias !== null
-                ? ($this->identifier[$alias] ??= $this->platform->quoteIdentifier($alias))
-                : $this->platform->quoteIdentifier(name: $table->table, prefix: $table->schema);
+                ? self::QI_OPEN . $alias . self::QI_CLOSE
+                : ($table->schema !== null
+                    ? self::QI_OPEN . $table->schema . self::QI_SEP . $table->table . self::QI_CLOSE
+                    : self::QI_OPEN . $table->table . self::QI_CLOSE);
         } else {
-            $prefix = $this->identifier[$alias] ??= $this->platform->quoteIdentifier($alias);
+            $prefix = self::QI_OPEN . $alias . self::QI_CLOSE;
         }
 
         return $this->tablePrefixCache[$id] = $prefix . $this->identifierSeparator;
@@ -165,8 +173,9 @@ public function renderIdentifiersIn(string $part): string
         $count       = count($identifiers);
 
         for ($idx = 1; $idx < $count; $idx += 2) {
-            $id                = $identifiers[$idx];
-            $identifiers[$idx] = $this->identifier[$id] ??= $this->platform->quoteIdentifier($id);
+            $identifiers[$idx] = self::QI_OPEN
+                . str_replace('.', self::QI_SEP, $identifiers[$idx])
+                . self::QI_CLOSE;
         }
 
         return implode('', $identifiers);
@@ -177,13 +186,21 @@ public function render(ExpressionInterface $expression, ?string $paramPrefix = n
         if ($this->parameterContainer === null) {
             $paramIndex = 0;
 
-            return $expression->toSql($this, '', $paramIndex);
+            return strtr(
+                $expression->toSql($this, '', $paramIndex),
+                self::QI_PAIR,
+                $this->quoteChars
+            );
         }
 
         $paramPrefix = $this->resolveParamPrefix($paramPrefix);
         $paramIndex  = &$this->instanceParameterIndex[$paramPrefix];
 
-        return $expression->toSql($this, $paramPrefix, $paramIndex);
+        return strtr(
+            $expression->toSql($this, $paramPrefix, $paramIndex),
+            self::QI_PAIR,
+            $this->quoteChars
+        );
     }
 
     public function renderArgument(
@@ -192,8 +209,7 @@ public function renderArgument(
         int &$paramIndex,
     ): string {
         return match (true) {
-            $argument instanceof Identifier    => $this->identifier[$argument->identifier]
-                ??= $this->platform->quoteIdentifier($argument->identifier),
+            $argument instanceof Identifier    => strtr($argument->qi, self::QI_PAIR, $this->quoteChars),
             $argument instanceof Literal       => $argument->literal,
             $argument instanceof NullValue     => 'NULL',
             $argument instanceof Parameter     => $this->bindParameter($argument),
@@ -240,22 +256,21 @@ public function processSubSelect(Select $subselect): string
             $this->subselectCount++;
             $this->paramPrefix = 'subselect' . $this->subselectCount;
 
-            $sql = $subselect->buildSqlString($this);
+            $sql = strtr($subselect->buildSqlString($this), self::QI_PAIR, $this->quoteChars);
 
             $this->paramPrefix = $savedPrefix;
             return $sql;
         }
 
-        return $subselect->buildSqlString($this);
+        return strtr($subselect->buildSqlString($this), self::QI_PAIR, $this->quoteChars);
     }
 
     /** @param list<Identifier> $identifiers */
     private function renderIdentifiers(array $identifiers): string
     {
         $quoted = [];
         foreach ($identifiers as $id) {
-            $name     = $id->identifier;
-            $quoted[] = $this->identifier[$name] ??= $this->platform->quoteIdentifier($name);
+            $quoted[] = strtr($id->qi, self::QI_PAIR, $this->quoteChars);
         }
         return implode(', ', $quoted);
     }
diff --git a/src/Sql/Sql.php b/src/Sql/Sql.php
@@ -9,6 +9,7 @@
 use PhpDb\Adapter\ParameterContainer;
 
 use function sprintf;
+use function strtr;
 
 class Sql
 {
@@ -120,7 +121,13 @@ public function prepareStatementForSqlObject(
         }
 
         $this->sqlRenderer->init($adapter->getPlatform(), $adapter->getDriver(), $parameterContainer);
-        $statement->setSql($sqlObject->buildSqlString($this->sqlRenderer));
+        $statement->setSql(
+            strtr(
+                $sqlObject->buildSqlString($this->sqlRenderer),
+                Platform\AbstractSqlRenderer::QI_PAIR,
+                $this->sqlRenderer->quoteChars
+            )
+        );
 
         return $statement;
     }
@@ -132,6 +139,10 @@ public function buildSqlString(AbstractSql $sqlObject, ?AdapterInterface $adapte
     {
         $this->sqlRenderer->init(($adapter ?? $this->adapter)->getPlatform());
 
-        return $sqlObject->buildSqlString($this->sqlRenderer);
+        return strtr(
+            $sqlObject->buildSqlString($this->sqlRenderer),
+            Platform\AbstractSqlRenderer::QI_PAIR,
+            $this->sqlRenderer->quoteChars
+        );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function toSql(AbstractSqlRenderer $renderer, string $paramPrefix = '', i`
`34`	`34`
`35`	`35`	`$columns = [];`
`36`	`36`	`foreach (array_keys($this->columns) as $name) {`
`37`		`- $columns[] = $renderer->identifier[$name] ??= $renderer->platform->quoteIdentifier($name);`
	`37`	`+ $columns[] = AbstractSqlRenderer::QI_OPEN . $name . AbstractSqlRenderer::QI_CLOSE;`
`38`	`38`	`}`
`39`	`39`	`$columnsSql = implode(', ', $columns);`
`40`	`40`