Use new column definition builder (#293)

Author: Tigrov

CHANGELOG.md

@@ -23,6 +23,7 @@
 - Enh #289: Refactor `Schema::normalizeDefaultValue()` method and move it to `ColumnFactory` class (@Tigrov)
 - New #292: Override `QueryBuilder::prepareBinary()` method (@Tigrov)
 - Chg #294: Update `QueryBuilder` constructor (@Tigrov)
+- Enh #293: Use `ColumnDefinitionBuilder` to generate table column SQL representation (@Tigrov)
 
 ## 1.3.0 March 21, 2024
 

src/Column.php

@@ -20,6 +20,10 @@
  *
  * Provides a fluent interface, which means that the methods can be chained together to create a column schema with
  * many properties in a single line of code.
+ *
+ * @psalm-suppress DeprecatedClass
+ *
+ * @deprecated Use {@see StringColumnSchema} or other column classes instead. Will be removed in 2.0.0.
  */
 final class Column extends AbstractColumn
 {

src/Column/ColumnDefinitionBuilder.php

@@ -16,8 +16,6 @@ final class ColumnDefinitionBuilder extends AbstractColumnDefinitionBuilder
 {
     protected const AUTO_INCREMENT_KEYWORD = 'GENERATED BY DEFAULT AS IDENTITY';
 
-    protected const GENERATE_UUID_EXPRESSION = 'sys_guid()';
-
     protected const TYPES_WITH_SIZE = [
         'char',
         'nchar',
@@ -99,4 +97,9 @@ protected function getDbType(ColumnSchemaInterface $column): string
             default => 'varchar2',
         };
     }
+
+    protected function getDefaultUuidExpression(): string
+    {
+        return 'sys_guid()';
+    }
 }

src/DDLQueryBuilder.php

@@ -8,6 +8,7 @@
 use Yiisoft\Db\Exception\NotSupportedException;
 use Yiisoft\Db\QueryBuilder\AbstractDDLQueryBuilder;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
+use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
 
 /**
  * Implements a (Data Definition Language) SQL statements for Oracle Server.
@@ -45,14 +46,13 @@ public function addForeignKey(
         return $sql;
     }
 
-    public function alterColumn(string $table, string $column, ColumnInterface|string $type): string
+    public function alterColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): string
     {
-        /** @psalm-suppress DeprecatedMethod */
         return 'ALTER TABLE '
             . $this->quoter->quoteTableName($table)
             . ' MODIFY '
             . $this->quoter->quoteColumnName($column)
-            . ' ' . $this->queryBuilder->getColumnType($type);
+            . ' ' . $this->queryBuilder->buildColumnDefinition($type);
     }
 
     public function checkIntegrity(string $schema = '', string $table = '', bool $check = true): string

src/Schema.php

@@ -73,6 +73,7 @@ public function __construct(protected ConnectionInterface $db, SchemaCache $sche
     /** @deprecated Use {@see ColumnBuilder} instead. Will be removed in 2.0. */
     public function createColumn(string $type, array|int|string $length = null): ColumnInterface
     {
+        /** @psalm-suppress DeprecatedClass */
         return new Column($type, $length);
     }
 

tests/ColumnSchemaBuilderTest.php

@@ -23,12 +23,4 @@ public function testCustomTypes(string $expected, string $type, int|null $length
     {
         $this->checkBuildString($expected, $type, $length, $calls);
     }
-
-    /**
-     * @dataProvider \Yiisoft\Db\Oracle\Tests\Provider\ColumnSchemaBuilderProvider::createColumnTypes
-     */
-    public function testCreateColumnTypes(string $expected, string $type, ?int $length, array $calls): void
-    {
-        parent::testCreateColumnTypes($expected, $type, $length, $calls);
-    }
 }

tests/Provider/ColumnSchemaBuilderProvider.php

@@ -22,23 +22,4 @@ public static function types(): array
             ['integer UNSIGNED', ColumnType::INTEGER, null, [['unsigned']]],
         ];
     }
-
-    public static function createColumnTypes(): array
-    {
-        $types = parent::createColumnTypes();
-        $types['integer'][0] = '"column" NUMBER(10)';
-
-        $types['uuid'][0] = '"column" RAW(16)';
-        $types['uuid not null'][0] = '"column" RAW(16) NOT NULL';
-
-        $types['uuid with default'][0] = '"column" RAW(16) DEFAULT HEXTORAW(REGEXP_REPLACE(\'875343b3-6bd0-4bec-81bb-aa68bb52d945\', \'-\', \'\'))';
-        $types['uuid with default'][3] = [['defaultExpression', 'HEXTORAW(REGEXP_REPLACE(\'875343b3-6bd0-4bec-81bb-aa68bb52d945\', \'-\', \'\'))']];
-
-        $types['uuid pk'][0] = '"column" RAW(16) DEFAULT SYS_GUID() PRIMARY KEY';
-        $types['uuid pk not null'][0] = '"column" RAW(16) DEFAULT SYS_GUID() PRIMARY KEY NOT NULL';
-        $types['uuid pk not null with default'][0] = '"column" RAW(16) DEFAULT SYS_GUID() PRIMARY KEY NOT NULL';
-        $types['uuid pk not null with default'][3] = [['notNull']];
-
-        return $types;
-    }
 }

tests/Provider/QueryBuilderProvider.php

@@ -5,6 +5,7 @@
 namespace Yiisoft\Db\Oracle\Tests\Provider;
 
 use Exception;
+use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Constant\PseudoType;
 use Yiisoft\Db\Constraint\ForeignKeyConstraint;
 use Yiisoft\Db\Expression\Expression;
@@ -44,6 +45,13 @@ public static function addForeignKey(): array
         return $addForeingKey;
     }
 
+    public static function alterColumn(): array
+    {
+        return [
+            [ColumnType::STRING, 'ALTER TABLE "foo1" MODIFY "bar" varchar2(255)'],
+        ];
+    }
+
     public static function batchInsert(): array
     {
         $batchInsert = parent::batchInsert();

tests/QueryBuilderTest.php

@@ -6,7 +6,6 @@
 
 use PHPUnit\Framework\Attributes\DataProviderExternal;
 use Throwable;
-use Yiisoft\Db\Constant\ColumnType;
 use Yiisoft\Db\Exception\Exception;
 use Yiisoft\Db\Exception\InvalidArgumentException;
 use Yiisoft\Db\Exception\InvalidConfigException;
@@ -28,6 +27,11 @@ final class QueryBuilderTest extends CommonQueryBuilderTest
 {
     use TestTrait;
 
+    public function getBuildColumnDefinitionProvider(): array
+    {
+        return QueryBuilderProvider::buildColumnDefinition();
+    }
+
     /**
      * @throws Exception
      * @throws InvalidConfigException
@@ -99,24 +103,10 @@ public function testAddUnique(string $name, string $table, array|string $columns
         parent::testAddUnique($name, $table, $columns, $expected);
     }
 
-    /**
-     * @throws Exception
-     * @throws InvalidConfigException
-     */
-    public function testAlterColumn(): void
+    #[DataProviderExternal(QueryBuilderProvider::class, 'alterColumn')]
+    public function testAlterColumn(string|ColumnSchemaInterface $type, string $expected): void
     {
-        $db = $this->getConnection();
-
-        $qb = $db->getQueryBuilder();
-
-        $this->assertSame(
-            <<<SQL
-            ALTER TABLE "customer" MODIFY "email" VARCHAR2(255)
-            SQL,
-            $qb->alterColumn('customer', 'email', ColumnType::STRING),
-        );
-
-        $db->close();
+        parent::testAlterColumn($type, $expected);
     }
 
     /**
@@ -312,11 +302,11 @@ public function testCreateTable(): void
         $this->assertSame(
             <<<SQL
             CREATE TABLE "test" (
-            \t"id" NUMBER(10) GENERATED BY DEFAULT AS IDENTITY NOT NULL PRIMARY KEY,
-            \t"name" VARCHAR2(255) NOT NULL,
-            \t"email" VARCHAR2(255) NOT NULL,
-            \t"status" NUMBER(10) NOT NULL,
-            \t"created_at" TIMESTAMP(0) NOT NULL
+            \t"id" number(10) GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY,
+            \t"name" varchar2(255) NOT NULL,
+            \t"email" varchar2(255) NOT NULL,
+            \t"status" number(10) NOT NULL,
+            \t"created_at" timestamp NOT NULL
             )
             SQL,
             $qb->createTable(