Use DateTimeColumn

CHANGELOG.md

@@ -40,6 +40,7 @@
 - New #353: Realize `Schema::loadResultColumn()` method (@Tigrov)
 - Enh #300: Remove realization of `Connection::createBatchQueryResult()` method (@Tigrov)
 - Bug #360: Fix columns order in composite primary key (@Tigrov)
+- New #358: Use `DateTimeColumn` class for datetime column types (@Tigrov)
 
 ## 1.2.0 March 21, 2024
 

src/Column/ColumnBuilder.php

@@ -13,4 +13,34 @@ public static function binary(int|null $size = null): ColumnInterface
     {
         return new BinaryColumn(ColumnType::BINARY, size: $size);
     }
+
+    public static function timestamp(int|null $size = 0): DateTimeColumn
+    {
+        return new DateTimeColumn(ColumnType::TIMESTAMP, size: $size);
+    }
+
+    public static function datetime(int|null $size = 0): DateTimeColumn
+    {
+        return new DateTimeColumn(ColumnType::DATETIME, size: $size);
+    }
+
+    public static function datetimeWithTimezone(int|null $size = 0): DateTimeColumn
+    {
+        return new DateTimeColumn(ColumnType::DATETIMETZ, size: $size);
+    }
+
+    public static function time(int|null $size = 0): DateTimeColumn
+    {
+        return new DateTimeColumn(ColumnType::TIME, size: $size);
+    }
+
+    public static function timeWithTimezone(int|null $size = 0): DateTimeColumn
+    {
+        return new DateTimeColumn(ColumnType::TIMETZ, size: $size);
+    }
+
+    public static function date(): DateTimeColumn
+    {
+        return new DateTimeColumn(ColumnType::DATE);
+    }
 }

src/Column/ColumnDefinitionBuilder.php

@@ -20,9 +20,9 @@ final class ColumnDefinitionBuilder extends AbstractColumnDefinitionBuilder
         'decimal',
         'numeric',
         'float',
-        'time',
         'datetime2',
         'datetimeoffset',
+        'time',
         'char',
         'varchar',
         'nchar',
@@ -124,10 +124,12 @@ protected function getDbType(ColumnInterface $column): string
             ColumnType::TEXT => 'nvarchar(max)',
             ColumnType::BINARY => 'varbinary(max)',
             ColumnType::UUID => 'uniqueidentifier',
-            ColumnType::DATETIME => 'datetime2',
             ColumnType::TIMESTAMP => 'datetime2',
-            ColumnType::DATE => 'date',
+            ColumnType::DATETIME => 'datetime2',
+            ColumnType::DATETIMETZ => 'datetimeoffset',
             ColumnType::TIME => 'time',
+            ColumnType::TIMETZ => 'time',
+            ColumnType::DATE => 'date',
             ColumnType::ARRAY => 'nvarchar(max)',
             ColumnType::STRUCTURED => 'nvarchar(max)',
             ColumnType::JSON => 'nvarchar(max)',

src/Column/ColumnFactory.php

@@ -40,12 +40,12 @@ final class ColumnFactory extends AbstractColumnFactory
         'double' => ColumnType::DOUBLE,
 
         /** Date and time */
-        'date' => ColumnType::DATE,
-        'time' => ColumnType::TIME,
         'smalldatetime' => ColumnType::DATETIME,
         'datetime' => ColumnType::DATETIME,
         'datetime2' => ColumnType::DATETIME,
-        'datetimeoffset' => ColumnType::DATETIME,
+        'datetimeoffset' => ColumnType::DATETIMETZ,
+        'time' => ColumnType::TIME,
+        'date' => ColumnType::DATE,
 
         /** Character strings */
         'char' => ColumnType::CHAR,
@@ -84,11 +84,16 @@ public function fromPseudoType(string $pseudoType, array $info = []): ColumnInte
 
     protected function getColumnClass(string $type, array $info = []): string
     {
-        if ($type === ColumnType::BINARY) {
-            return BinaryColumn::class;
-        }
-
-        return parent::getColumnClass($type, $info);
+        return match ($type) {
+            ColumnType::BINARY => BinaryColumn::class,
+            ColumnType::TIMESTAMP => DateTimeColumn::class,
+            ColumnType::DATETIME => DateTimeColumn::class,
+            ColumnType::DATETIMETZ => DateTimeColumn::class,
+            ColumnType::TIME => DateTimeColumn::class,
+            ColumnType::TIMETZ => DateTimeColumn::class,
+            ColumnType::DATE => DateTimeColumn::class,
+            default => parent::getColumnClass($type, $info),
+        };
     }
 
     protected function getType(string $dbType, array $info = []): string

src/Column/DateTimeColumn.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Db\Mssql\Column;
+
+final class DateTimeColumn extends \Yiisoft\Db\Schema\Column\DateTimeColumn
+{
+    protected function getMillisecondsFormat(): string
+    {
+        return match ($this->getDbType()) {
+            'smalldatetime' => '',
+            'datetime' => '.v',
+            default => parent::getMillisecondsFormat(),
+        };
+    }
+}

tests/ColumnBuilderTest.php

@@ -4,7 +4,9 @@
 
 namespace Yiisoft\Db\Mssql\Tests;
 
+use PHPUnit\Framework\Attributes\DataProviderExternal;
 use Yiisoft\Db\Mssql\Column\ColumnBuilder;
+use Yiisoft\Db\Mssql\Tests\Provider\ColumnBuilderProvider;
 use Yiisoft\Db\Mssql\Tests\Support\TestTrait;
 use Yiisoft\Db\Tests\AbstractColumnBuilderTest;
 
@@ -20,9 +22,7 @@ public function getColumnBuilderClass(): string
         return ColumnBuilder::class;
     }
 
-    /**
-     * @dataProvider \Yiisoft\Db\Mssql\Tests\Provider\ColumnBuilderProvider::buildingMethods
-     */
+    #[DataProviderExternal(ColumnBuilderProvider::class, 'buildingMethods')]
     public function testBuildingMethods(
         string $buildingMethod,
         array $args,

tests/ColumnTest.php

@@ -4,29 +4,36 @@
 
 namespace Yiisoft\Db\Mssql\Tests;
 
+use DateTimeImmutable;
+use DateTimeZone;
 use PDO;
+use PHPUnit\Framework\Attributes\DataProviderExternal;
 use Yiisoft\Db\Command\Param;
 use Yiisoft\Db\Expression\Expression;
 use Yiisoft\Db\Mssql\Column\BinaryColumn;
+use Yiisoft\Db\Mssql\Column\ColumnBuilder;
 use Yiisoft\Db\Mssql\Connection;
+use Yiisoft\Db\Mssql\Tests\Provider\ColumnProvider;
 use Yiisoft\Db\Mssql\Tests\Support\TestTrait;
 use Yiisoft\Db\Query\Query;
 use Yiisoft\Db\Schema\Column\BooleanColumn;
 use Yiisoft\Db\Schema\Column\ColumnInterface;
 use Yiisoft\Db\Schema\Column\DoubleColumn;
 use Yiisoft\Db\Schema\Column\IntegerColumn;
 use Yiisoft\Db\Schema\Column\StringColumn;
-use Yiisoft\Db\Tests\AbstractColumnTest;
+use Yiisoft\Db\Tests\Common\CommonColumnTest;
 
 use function str_repeat;
 
 /**
  * @group mssql
  */
-final class ColumnTest extends AbstractColumnTest
+final class ColumnTest extends CommonColumnTest
 {
     use TestTrait;
 
+    protected const COLUMN_BUILDER = ColumnBuilder::class;
+
     private function insertTypeValues(Connection $db): void
     {
         $db->createCommand()->insert(
@@ -44,16 +51,21 @@ private function insertTypeValues(Connection $db): void
         )->execute();
     }
 
-    private function assertResultValues(array $result): void
+    private function assertTypecastedValues(array $result, bool $allTypecasted = false): void
     {
         $this->assertSame(1, $result['int_col']);
         $this->assertSame(str_repeat('x', 100), $result['char_col']);
         $this->assertNull($result['char_col3']);
         $this->assertSame(1.234, $result['float_col']);
         $this->assertSame("\x10\x11\x12", $result['blob_col']);
-        $this->assertSame('2023-07-11 14:50:00.123', $result['datetime_col']);
+        $this->assertEquals(new DateTimeImmutable('2023-07-11 14:50:00.123', new DateTimeZone('UTC')), $result['datetime_col']);
         $this->assertFalse($result['bool_col']);
-        $this->assertSame('[{"a":1,"b":null,"c":[1,3,5]}]', $result['json_col']);
+
+        if ($allTypecasted) {
+            $this->assertSame([['a' => 1, 'b' => null, 'c' => [1, 3, 5]]], $result['json_col']);
+        } else {
+            $this->assertSame('[{"a":1,"b":null,"c":[1,3,5]}]', $result['json_col']);
+        }
     }
 
     public function testQueryWithTypecasting(): void
@@ -66,11 +78,11 @@ public function testQueryWithTypecasting(): void
 
         $result = $query->one();
 
-        $this->assertResultValues($result);
+        $this->assertTypecastedValues($result);
 
         $result = $query->all();
 
-        $this->assertResultValues($result[0]);
+        $this->assertTypecastedValues($result[0]);
 
         $db->close();
     }
@@ -85,11 +97,11 @@ public function testCommandWithPhpTypecasting(): void
 
         $result = $command->queryOne();
 
-        $this->assertResultValues($result);
+        $this->assertTypecastedValues($result);
 
         $result = $command->queryAll();
 
-        $this->assertResultValues($result[0]);
+        $this->assertTypecastedValues($result[0]);
 
         $db->close();
     }
@@ -138,29 +150,19 @@ public function testPhpTypeCast(): void
     {
         $db = $this->getConnection(true);
         $schema = $db->getSchema();
-        $tableSchema = $schema->getTableSchema('type');
+        $columns = $schema->getTableSchema('type')->getColumns();
 
         $this->insertTypeValues($db);
 
         $query = (new Query($db))->from('type')->one();
 
-        $intColPhpType = $tableSchema->getColumn('int_col')?->phpTypecast($query['int_col']);
-        $charColPhpType = $tableSchema->getColumn('char_col')?->phpTypecast($query['char_col']);
-        $charCol3PhpType = $tableSchema->getColumn('char_col3')?->phpTypecast($query['char_col3']);
-        $floatColPhpType = $tableSchema->getColumn('float_col')?->phpTypecast($query['float_col']);
-        $blobColPhpType = $tableSchema->getColumn('blob_col')?->phpTypecast($query['blob_col']);
-        $datetimeColPhpType = $tableSchema->getColumn('datetime_col')?->phpTypecast($query['datetime_col']);
-        $boolColPhpType = $tableSchema->getColumn('bool_col')?->phpTypecast($query['bool_col']);
-        $jsonColPhpType = $tableSchema->getColumn('json_col')?->phpTypecast($query['json_col']);
-
-        $this->assertSame(1, $intColPhpType);
-        $this->assertSame(str_repeat('x', 100), $charColPhpType);
-        $this->assertNull($charCol3PhpType);
-        $this->assertSame(1.234, $floatColPhpType);
-        $this->assertSame("\x10\x11\x12", $blobColPhpType);
-        $this->assertSame('2023-07-11 14:50:00.123', $datetimeColPhpType);
-        $this->assertFalse($boolColPhpType);
-        $this->assertSame([['a' => 1, 'b' => null, 'c' => [1, 3, 5]]], $jsonColPhpType);
+        $result = [];
+
+        foreach ($columns as $columnName => $column) {
+            $result[$columnName] = $column->phpTypecast($query[$columnName]);
+        }
+
+        $this->assertTypecastedValues($result, true);
 
         $db->close();
     }
@@ -178,18 +180,24 @@ public function testColumnInstance()
         $this->assertInstanceOf(BooleanColumn::class, $tableSchema->getColumn('bool_col'));
     }
 
-    /** @dataProvider \Yiisoft\Db\Mssql\Tests\Provider\ColumnProvider::predefinedTypes */
+    #[DataProviderExternal(ColumnProvider::class, 'predefinedTypes')]
     public function testPredefinedType(string $className, string $type, string $phpType)
     {
         parent::testPredefinedType($className, $type, $phpType);
     }
 
-    /** @dataProvider \Yiisoft\Db\Mssql\Tests\Provider\ColumnProvider::dbTypecastColumns */
+    #[DataProviderExternal(ColumnProvider::class, 'dbTypecastColumns')]
     public function testDbTypecastColumns(ColumnInterface $column, array $values)
     {
         parent::testDbTypecastColumns($column, $values);
     }
 
+    #[DataProviderExternal(ColumnProvider::class, 'phpTypecastColumns')]
+    public function testPhpTypecastColumns(ColumnInterface $column, array $values)
+    {
+        parent::testPhpTypecastColumns($column, $values);
+    }
+
     public function testBinaryColumn()
     {
         $binaryCol = new BinaryColumn();

tests/Provider/ColumnBuilderProvider.php

@@ -5,6 +5,7 @@
 namespace Yiisoft\Db\Mssql\Tests\Provider;
 
 use Yiisoft\Db\Mssql\Column\BinaryColumn;
+use Yiisoft\Db\Mssql\Column\DateTimeColumn;
 
 class ColumnBuilderProvider extends \Yiisoft\Db\Tests\Provider\ColumnBuilderProvider
 {
@@ -14,6 +15,17 @@ public static function buildingMethods(): array
 
         $values['binary()'][2] = BinaryColumn::class;
         $values['binary(8)'][2] = BinaryColumn::class;
+        $values['timestamp()'][2] = DateTimeColumn::class;
+        $values['timestamp(3)'][2] = DateTimeColumn::class;
+        $values['datetime()'][2] = DateTimeColumn::class;
+        $values['datetime(3)'][2] = DateTimeColumn::class;
+        $values['datetimeWithTimezone()'][2] = DateTimeColumn::class;
+        $values['datetimeWithTimezone(3)'][2] = DateTimeColumn::class;
+        $values['time()'][2] = DateTimeColumn::class;
+        $values['time(3)'][2] = DateTimeColumn::class;
+        $values['timeWithTimezone()'][2] = DateTimeColumn::class;
+        $values['timeWithTimezone(3)'][2] = DateTimeColumn::class;
+        $values['date()'][2] = DateTimeColumn::class;
 
         return $values;
     }

tests/Provider/ColumnFactoryProvider.php

@@ -7,6 +7,7 @@
 use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Expression\Expression;
 use Yiisoft\Db\Mssql\Column\BinaryColumn;
+use Yiisoft\Db\Mssql\Column\DateTimeColumn;
 use Yiisoft\Db\Schema\Column\ArrayColumn;
 use Yiisoft\Db\Schema\Column\BooleanColumn;
 use Yiisoft\Db\Schema\Column\DoubleColumn;
@@ -40,12 +41,12 @@ public static function dbTypes(): array
             ['double', ColumnType::DOUBLE, DoubleColumn::class],
             ['smallmoney', ColumnType::MONEY, StringColumn::class],
             ['money', ColumnType::MONEY, StringColumn::class],
-            ['date', ColumnType::DATE, StringColumn::class],
-            ['time', ColumnType::TIME, StringColumn::class],
-            ['smalldatetime', ColumnType::DATETIME, StringColumn::class],
-            ['datetime', ColumnType::DATETIME, StringColumn::class],
-            ['datetime2', ColumnType::DATETIME, StringColumn::class],
-            ['datetimeoffset', ColumnType::DATETIME, StringColumn::class],
+            ['smalldatetime', ColumnType::DATETIME, DateTimeColumn::class],
+            ['datetime', ColumnType::DATETIME, DateTimeColumn::class],
+            ['datetime2', ColumnType::DATETIME, DateTimeColumn::class],
+            ['datetimeoffset', ColumnType::DATETIMETZ, DateTimeColumn::class],
+            ['time', ColumnType::TIME, DateTimeColumn::class],
+            ['date', ColumnType::DATE, DateTimeColumn::class],
             ['char', ColumnType::CHAR, StringColumn::class],
             ['varchar', ColumnType::STRING, StringColumn::class],
             ['text', ColumnType::TEXT, StringColumn::class],