Add option for typecasting when insert or update values.

CHANGELOG.md

@@ -78,6 +78,7 @@
 - Enh #925, #951: Add callback to `Query::all()` and `Query::one()` methods (@Tigrov, @vjik)
 - New #954: Add `DbArrayHelper::arrange()` method (@Tigrov)
 - Chg #956: Remove nullable from `PdoConnectionInterface::getActivePdo()` result (@vjik)
+- New #949: Add option for typecasting when insert or update values (@Tigrov)
 
 ## 1.3.0 March 21, 2024
 

src/Command/AbstractCommand.php

@@ -120,6 +120,7 @@ abstract class AbstractCommand implements CommandInterface
      */
     protected string|null $refreshTableName = null;
     protected Closure|null $retryHandler = null;
+    protected bool $dbTypecasting = true;
     /**
      * @var string The SQL statement to execute.
      */
@@ -252,6 +253,12 @@ public function createView(string $viewName, QueryInterface|string $subQuery): s
         return $this->setSql($sql)->requireTableSchemaRefresh($viewName);
     }
 
+    public function dbTypecasting(bool $dbTypecasting = true): static
+    {
+        $this->dbTypecasting = $dbTypecasting;
+        return $this;
+    }
+
     public function delete(string $table, array|string $condition = '', array $params = []): static
     {
         $sql = $this->getQueryBuilder()->delete($table, $condition, $params);

src/Command/CommandInterface.php

@@ -378,6 +378,11 @@ public function createTable(string $table, array $columns, ?string $options = nu
      */
     public function createView(string $viewName, QueryInterface|string $subQuery): static;
 
+    /**
+     * Enables or disables typecasting of values when inserting or updating records.
+     */
+    public function dbTypecasting(bool $dbTypecasting = true): static;
+
     /**
      * Creates a DELETE command.
      *

src/Debug/CommandInterfaceProxy.php

@@ -177,6 +177,14 @@ public function createView(string $viewName, QueryInterface|string $subQuery): s
         return new self($this->decorated->{__FUNCTION__}(...func_get_args()), $this->collector);
     }
 
+    /**
+     * @psalm-suppress MixedArgument
+     */
+    public function dbTypecasting(bool $dbTypecasting = true): static
+    {
+        return new self($this->decorated->{__FUNCTION__}(...func_get_args()), $this->collector);
+    }
+
     /**
      * @psalm-suppress MixedArgument
      */

src/Driver/Pdo/AbstractPdoCommand.php

@@ -168,7 +168,7 @@
 
     protected function getQueryBuilder(): QueryBuilderInterface
     {
-        return $this->db->getQueryBuilder();
+        return $this->db->getQueryBuilder()->withTypecasting($this->dbTypecasting);
     }
 
     protected function getQueryMode(int $queryMode): string

src/QueryBuilder/AbstractDMLQueryBuilder.php

@@ -55,6 +55,8 @@
  */
 abstract class AbstractDMLQueryBuilder implements DMLQueryBuilderInterface
 {
+    protected bool $typecasting = true;
+
     public function __construct(
         protected QueryBuilderInterface $queryBuilder,
         protected QuoterInterface $quoter,
@@ -145,6 +147,13 @@ public function upsert(
         throw new NotSupportedException(__METHOD__ . ' is not supported by this DBMS.');
     }
 
+    public function withTypecasting(bool $typecasting = true): static
+    {
+        $new = clone $this;
+        $new->typecasting = $typecasting;
+        return $new;
+    }
+
     /**
      * Prepare traversable for batch insert.
      *
@@ -186,7 +195,7 @@ protected function prepareBatchInsertValues(string $table, iterable $rows, array
         /** @var string[] $names */
         $names = array_values($columnNames);
         $keys = array_fill_keys($names, false);
-        $columns = $this->schema->getTableSchema($table)?->getColumns() ?? [];
+        $columns = $this->typecasting ? $this->schema->getTableSchema($table)?->getColumns() ?? [] : [];
 
         foreach ($rows as $row) {
             $i = 0;
@@ -339,7 +348,7 @@ protected function prepareInsertValues(string $table, array|QueryInterface $colu
         $names = [];
         $placeholders = [];
         $columns = $this->normalizeColumnNames($columns);
-        $tableColumns = $this->schema->getTableSchema($table)?->getColumns() ?? [];
+        $tableColumns = $this->typecasting ? $this->schema->getTableSchema($table)?->getColumns() ?? [] : [];
 
         foreach ($columns as $name => $value) {
             $names[] = $this->quoter->quoteColumnName($name);
@@ -373,7 +382,7 @@ protected function prepareUpdateSets(string $table, array $columns, array $param
     {
         $sets = [];
         $columns = $this->normalizeColumnNames($columns);
-        $tableColumns = $this->schema->getTableSchema($table)?->getColumns() ?? [];
+        $tableColumns = $this->typecasting ? $this->schema->getTableSchema($table)?->getColumns() ?? [] : [];
 
         foreach ($columns as $name => $value) {
             if (isset($tableColumns[$name])) {

src/QueryBuilder/AbstractQueryBuilder.php

@@ -471,6 +471,13 @@ public function upsert(
         return $this->dmlBuilder->upsert($table, $insertColumns, $updateColumns, $params);
     }
 
+    public function withTypecasting(bool $typecasting = true): static
+    {
+        $new = clone $this;
+        $new->dmlBuilder = $new->dmlBuilder->withTypecasting($typecasting);
+        return $new;
+    }
+
     /**
      * Converts a resource value to its SQL representation or throws an exception if conversion is not possible.
      *

src/QueryBuilder/DMLQueryBuilderInterface.php

@@ -227,4 +227,6 @@ public function upsert(
         bool|array $updateColumns,
         array &$params
     ): string;
+
+    public function withTypecasting(bool $typecasting = true): static;
 }

tests/Common/CommonCommandTest.php

@@ -1506,6 +1506,72 @@ public function testInsertToBlob(): void
         $db->close();
     }
 
+    public function testInsertWithoutTypecasting(): void
+    {
+        $db = $this->getConnection(true);
+        $command = $db->createCommand();
+
+        $values = [
+            'int_col' => '1',
+            'char_col' => 'test',
+            'float_col' => '3.14',
+            'bool_col' => '1',
+        ];
+
+        $command->insert('{{type}}', $values);
+
+        $this->assertSame([
+            ':qp0' => 1,
+            ':qp1' => 'test',
+            ':qp2' => 3.14,
+            ':qp3' => $db->getDriverName() === 'oci' ? '1' : true,
+        ], $command->getParams());
+
+        $command->dbTypecasting(false)->insert('{{type}}', $values);
+
+        $this->assertSame([
+            ':qp0' => '1',
+            ':qp1' => 'test',
+            ':qp2' => '3.14',
+            ':qp3' => '1',
+        ], $command->getParams());
+
+        $db->close();
+    }
+
+    public function testInsertBatchWithoutTypecasting(): void
+    {
+        $db = $this->getConnection(true);
+        $command = $db->createCommand();
+
+        $values = [
+            'int_col' => '1',
+            'char_col' => 'test',
+            'float_col' => '3.14',
+            'bool_col' => '1',
+        ];
+
+        $command->insertBatch('{{type}}', [$values]);
+
+        $this->assertSame([
+            ':qp0' => 1,
+            ':qp1' => 'test',
+            ':qp2' => 3.14,
+            ':qp3' => $db->getDriverName() === 'oci' ? '1' : true,
+        ], $command->getParams());
+
+        $command->dbTypecasting(false)->insertBatch('{{type}}', [$values]);
+
+        $this->assertSame([
+            ':qp0' => '1',
+            ':qp1' => 'test',
+            ':qp2' => '3.14',
+            ':qp3' => '1',
+        ], $command->getParams());
+
+        $db->close();
+    }
+
     /**
      * @throws Exception
      * @throws InvalidConfigException
@@ -1985,6 +2051,37 @@ public function testUpdate(
         $db->close();
     }
 
+    public function testUpdateWithoutTypecasting(): void
+    {
+        $db = $this->getConnection(true);
+        $command = $db->createCommand();
+
+        $values = [
+            'int_col' => '1',
+            'char_col' => 'test',
+            'float_col' => '3.14',
+            'bool_col' => '1',
+        ];
+
+        $command->update('{{type}}', $values);
+
+        $this->assertSame([
+            ':qp0' => 1,
+            ':qp1' => 'test',
+            ':qp2' => 3.14,
+            ':qp3' => $db->getDriverName() === 'oci' ? '1' : true,
+        ], $command->getParams());
+
+        $command->dbTypecasting(false)->update('{{type}}', $values);
+
+        $this->assertSame([
+            ':qp0' => '1',
+            ':qp1' => 'test',
+            ':qp2' => '3.14',
+            ':qp3' => '1',
+        ], $command->getParams());
+    }
+
     /**
      * @dataProvider \Yiisoft\Db\Tests\Provider\CommandProvider::upsert
      *

tests/Common/CommonQueryBuilderTest.php

@@ -13,6 +13,16 @@
 
 abstract class CommonQueryBuilderTest extends AbstractQueryBuilderTest
 {
+    private function createTebleWithColumn(CommandInterface $command, string|ColumnInterface $column)
+    {
+        try {
+            $command->dropTable('build_column_definition_primary_key')->execute();
+        } catch (Exception) {
+        }
+
+        $command->createTable('build_column_definition_primary_key', ['id' => $column])->execute();
+    }
+
     public function getBuildColumnDefinitionProvider(): array
     {
         return QueryBuilderProvider::buildColumnDefinition();
@@ -60,13 +70,106 @@ public function testCreateTableWithBuildColumnDefinition(): void
         $command->createTable('build_column_definition', $columns)->execute();
     }
 
-    private function createTebleWithColumn(CommandInterface $command, string|ColumnInterface $column)
+    public function testInsertWithoutTypecasting(): void
     {
-        try {
-            $command->dropTable('build_column_definition_primary_key')->execute();
-        } catch (Exception) {
-        }
+        $db = $this->getConnection(true);
+        $qb = $db->getQueryBuilder();
+
+        $values = [
+            'int_col' => '1',
+            'char_col' => 'test',
+            'float_col' => '3.14',
+            'bool_col' => '1',
+        ];
+
+        $params = [];
+        $qb->insert('{{type}}', $values, $params);
+
+        $this->assertSame([
+            ':qp0' => 1,
+            ':qp1' => 'test',
+            ':qp2' => 3.14,
+            ':qp3' => $db->getDriverName() === 'oci' ? '1' : true,
+        ], $params);
+
+        $params = [];
+        $qb->withTypecasting(false)->insert('{{type}}', $values, $params);
+
+        $this->assertSame([
+            ':qp0' => '1',
+            ':qp1' => 'test',
+            ':qp2' => '3.14',
+            ':qp3' => '1',
+        ], $params);
+
+        $db->close();
+    }
 
-        $command->createTable('build_column_definition_primary_key', ['id' => $column])->execute();
+    public function testInsertBatchWithoutTypecasting(): void
+    {
+        $db = $this->getConnection(true);
+        $qb = $db->getQueryBuilder();
+
+        $values = [
+            'int_col' => '1',
+            'char_col' => 'test',
+            'float_col' => '3.14',
+            'bool_col' => '1',
+        ];
+
+        $params = [];
+        $qb->insertBatch('{{type}}', [$values], [], $params);
+
+        $this->assertSame([
+            ':qp0' => 1,
+            ':qp1' => 'test',
+            ':qp2' => 3.14,
+            ':qp3' => $db->getDriverName() === 'oci' ? '1' : true,
+        ], $params);
+
+        $params = [];
+        $qb->withTypecasting(false)->insertBatch('{{type}}', [$values], [], $params);
+
+        $this->assertSame([
+            ':qp0' => '1',
+            ':qp1' => 'test',
+            ':qp2' => '3.14',
+            ':qp3' => '1',
+        ], $params);
+
+        $db->close();
+    }
+
+    public function testUpdateWithoutTypecasting(): void
+    {
+        $db = $this->getConnection(true);
+        $qb = $db->getQueryBuilder();
+
+        $values = [
+            'int_col' => '1',
+            'char_col' => 'test',
+            'float_col' => '3.14',
+            'bool_col' => '1',
+        ];
+
+        $params = [];
+        $qb->update('{{type}}', $values, [], $params);
+
+        $this->assertSame([
+            ':qp0' => 1,
+            ':qp1' => 'test',
+            ':qp2' => 3.14,
+            ':qp3' => $db->getDriverName() === 'oci' ? '1' : true,
+        ], $params);
+
+        $params = [];
+        $qb->withTypecasting(false)->update('{{type}}', $values, [], $params);
+
+        $this->assertSame([
+            ':qp0' => '1',
+            ':qp1' => 'test',
+            ':qp2' => '3.14',
+            ':qp3' => '1',
+        ], $params);
     }
 }

tests/Db/Command/CommandTest.php

@@ -751,4 +751,20 @@ public function testProfilerData(?string $sql = null): void
         );
         parent::testProfilerData();
     }
+
+    public function testDbTypecasting(): void
+    {
+        $db = $this->getConnection();
+        $command = $db->createCommand();
+
+        $this->assertTrue(Assert::getInaccessibleProperty($command, 'dbTypecasting'));
+
+        $command->dbTypecasting(false);
+
+        $this->assertFalse(Assert::getInaccessibleProperty($command, 'dbTypecasting'));
+
+        $command->dbTypecasting();
+
+        $this->assertTrue(Assert::getInaccessibleProperty($command, 'dbTypecasting'));
+    }
 }