Use new column definition builder

yiisoft · Dec 1, 2024 · 92d58ac · 92d58ac
1 parent cc8ae67
commit 92d58ac
Show file tree

Hide file tree

Showing 19 changed files with 153 additions and 204 deletions.
diff --git a/src/Command/AbstractCommand.php b/src/Command/AbstractCommand.php
@@ -12,6 +12,7 @@
 use Yiisoft\Db\QueryBuilder\DMLQueryBuilderInterface;
 use Yiisoft\Db\QueryBuilder\QueryBuilderInterface;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
+use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
 
 use function explode;
 use function get_resource_type;
@@ -131,7 +132,7 @@ public function addCheck(string $table, string $name, string $expression): stati
         return $this->setSql($sql)->requireTableSchemaRefresh($table);
     }
 
-    public function addColumn(string $table, string $column, ColumnInterface|string $type): static
+    public function addColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): static
     {
         $sql = $this->getQueryBuilder()->addColumn($table, $column, $type);
         return $this->setSql($sql)->requireTableSchemaRefresh($table);
@@ -188,7 +189,7 @@ public function addUnique(string $table, string $name, array|string $columns): s
         return $this->setSql($sql)->requireTableSchemaRefresh($table);
     }
 
-    public function alterColumn(string $table, string $column, ColumnInterface|string $type): static
+    public function alterColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): static
     {
         $sql = $this->getQueryBuilder()->alterColumn($table, $column, $type);
         return $this->setSql($sql)->requireTableSchemaRefresh($table);

diff --git a/src/Command/CommandInterface.php b/src/Command/CommandInterface.php
@@ -17,6 +17,7 @@
 use Yiisoft\Db\Query\QueryInterface;
 use Yiisoft\Db\QueryBuilder\DMLQueryBuilderInterface;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
+use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
 
 /**
  * This interface represents a database command, such as a `SELECT`, `INSERT`, `UPDATE`, or `DELETE` statement.
@@ -44,13 +45,13 @@ public function addCheck(string $table, string $name, string $expression): stati
      *
      * @param string $table The name of the table to add new column to.
      * @param string $column The name of the new column.
-     * @param ColumnInterface|string $type The column type. {@see QueryBuilder::getColumnType()} will be called
-     * to convert the given column type to the database one.
+     * @param ColumnInterface|ColumnSchemaInterface|string $type The column type.
+     * {@see QueryBuilder::buildColumnDefinition()} will be called to convert the given column type to the database one.
      * For example, `string` will be converted to `varchar(255)`, and `string not null` becomes `varchar(255) not null`.
      *
      * Note: The method will quote the `table` and `column` parameters before using them in the generated SQL.
      */
-    public function addColumn(string $table, string $column, ColumnInterface|string $type): static;
+    public function addColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): static;
 
     /**
      * Builds an SQL command for adding a comment to a column.
@@ -144,13 +145,13 @@ public function addPrimaryKey(string $table, string $name, array|string $columns
      *
      * @param string $table The table whose column is to change.
      * @param string $column The name of the column to change.
-     * @param ColumnInterface|string $type The column type. {@see QueryBuilder::getColumnType()} will be called to
-     * convert the give column type to the physical one. For example, `string` will be converted as `varchar(255)`, and
-     * `string not null` becomes `varchar(255) not null`.
+     * @param ColumnInterface|ColumnSchemaInterface|string $type The column type.
+     * {@see QueryBuilder::buildColumnDefinition()} will be called to convert the give column type to the physical one.
+     * For example, `string` will be converted as `varchar(255)`, and `string not null` becomes `varchar(255) not null`.
      *
      * Note: The method will quote the `table` and `column` parameters before using them in the generated SQL.
      */
-    public function alterColumn(string $table, string $column, ColumnInterface|string $type): static;
+    public function alterColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): static;
 
     /**
      * Creates a batch INSERT command.
@@ -327,8 +328,8 @@ public function createIndex(
      * into the generated SQL.
      *
      * @param string $table The name of the table to create.
-     * @param array $columns The columns (name => definition) in the new table.
-     * The definition can be `string` or {@see ColumnInterface} instance.
+     * @param (ColumnSchemaInterface|string)[] $columns The columns (name => definition) in the new table.
+     * The definition can be `string` or {@see ColumnSchemaInterface} instance.
      * @param string|null $options More SQL fragments to append to the generated SQL.
      *
      * @throws Exception
@@ -337,7 +338,7 @@ public function createIndex(
      *
      * Note: The method will quote the `table` and `columns` parameter before using it in the generated SQL.
      *
-     * @psalm-param array<string, ColumnInterface>|string[] $columns
+     * @psalm-param array<string, ColumnSchemaInterface>|string[] $columns
      */
     public function createTable(string $table, array $columns, string $options = null): static;
 

diff --git a/src/Debug/CommandInterfaceProxy.php b/src/Debug/CommandInterfaceProxy.php
@@ -10,6 +10,7 @@
 use Yiisoft\Db\Query\Data\DataReaderInterface;
 use Yiisoft\Db\Query\QueryInterface;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
+use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
 
 final class CommandInterfaceProxy implements CommandInterface
 {
@@ -30,7 +31,7 @@ public function addCheck(string $table, string $name, string $expression): stati
     /**
      * @psalm-suppress MixedArgument
      */
-    public function addColumn(string $table, string $column, ColumnInterface|string $type): static
+    public function addColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): static
     {
         return new self($this->decorated->{__FUNCTION__}(...func_get_args()), $this->collector);
     }
@@ -93,7 +94,7 @@ public function addUnique(string $table, string $name, array|string $columns): s
     /**
      * @psalm-suppress MixedArgument
      */
-    public function alterColumn(string $table, string $column, ColumnInterface|string $type): static
+    public function alterColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): static
     {
         return new self($this->decorated->{__FUNCTION__}(...func_get_args()), $this->collector);
     }

diff --git a/src/QueryBuilder/AbstractColumnDefinitionBuilder.php b/src/QueryBuilder/AbstractColumnDefinitionBuilder.php
@@ -65,6 +65,11 @@ public function build(ColumnSchemaInterface $column): string
             . $this->buildExtra($column);
     }
 
+    public function buildAlter(ColumnSchemaInterface $column): string
+    {
+        return $this->build($column);
+    }
+
     /**
      * Builds the auto increment clause for the column.
      *

diff --git a/src/QueryBuilder/AbstractDDLQueryBuilder.php b/src/QueryBuilder/AbstractDDLQueryBuilder.php
@@ -7,6 +7,7 @@
 use Yiisoft\Db\Exception\NotSupportedException;
 use Yiisoft\Db\Query\QueryInterface;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
+use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
 use Yiisoft\Db\Schema\QuoterInterface;
 use Yiisoft\Db\Schema\SchemaInterface;
 
@@ -39,15 +40,14 @@ public function addCheck(string $table, string $name, string $expression): strin
             . ' CHECK (' . $this->quoter->quoteSql($expression) . ')';
     }
 
-    public function addColumn(string $table, string $column, ColumnInterface|string $type): string
+    public function addColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): string
     {
-        /** @psalm-suppress DeprecatedMethod */
         return 'ALTER TABLE '
             . $this->quoter->quoteTableName($table)
             . ' ADD '
             . $this->quoter->quoteColumnName($column)
             . ' '
-            . $this->queryBuilder->getColumnType($type);
+            . $this->queryBuilder->buildColumnDefinition($type);
     }
 
     public function addCommentOnColumn(string $table, string $column, string $comment): string
@@ -137,16 +137,15 @@ public function addUnique(string $table, string $name, array|string $columns): s
     public function alterColumn(
         string $table,
         string $column,
-        ColumnInterface|string $type
+        ColumnInterface|ColumnSchemaInterface|string $type
     ): string {
-        /** @psalm-suppress DeprecatedMethod */
         return 'ALTER TABLE '
             . $this->quoter->quoteTableName($table)
             . ' CHANGE '
             . $this->quoter->quoteColumnName($column)
             . ' '
             . $this->quoter->quoteColumnName($column) . ' '
-            . $this->queryBuilder->getColumnType($type);
+            . $this->queryBuilder->buildColumnDefinition($type);
     }
 
     public function checkIntegrity(string $schema = '', string $table = '', bool $check = true): string
@@ -173,11 +172,10 @@ public function createTable(string $table, array $columns, string $options = nul
 
         foreach ($columns as $name => $type) {
             if (is_string($name)) {
-                /** @psalm-suppress DeprecatedMethod */
                 $cols[] = "\t"
                     . $this->quoter->quoteColumnName($name)
                     . ' '
-                    . $this->queryBuilder->getColumnType($type);
+                    . $this->queryBuilder->buildColumnDefinition($type);
             } else {
                 /** @psalm-var string $type */
                 $cols[] = "\t" . $type;

diff --git a/src/QueryBuilder/AbstractQueryBuilder.php b/src/QueryBuilder/AbstractQueryBuilder.php
@@ -79,7 +79,7 @@ public function addCheck(string $table, string $name, string $expression): strin
         return $this->ddlBuilder->addCheck($table, $name, $expression);
     }
 
-    public function addColumn(string $table, string $column, ColumnInterface|string $type): string
+    public function addColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): string
     {
         return $this->ddlBuilder->addColumn($table, $column, $type);
     }
@@ -129,7 +129,7 @@ public function addUnique(string $table, string $name, array|string $columns): s
         return $this->ddlBuilder->addUnique($table, $name, $columns);
     }
 
-    public function alterColumn(string $table, string $column, ColumnInterface|string $type): string
+    public function alterColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): string
     {
         return $this->ddlBuilder->alterColumn($table, $column, $type);
     }
@@ -173,8 +173,12 @@ public function build(QueryInterface $query, array $params = []): array
         return $this->dqlBuilder->build($query, $params);
     }
 
-    public function buildColumnDefinition(ColumnSchemaInterface|string $column): string
+    public function buildColumnDefinition(ColumnInterface|ColumnSchemaInterface|string $column): string
     {
+        if ($column instanceof ColumnInterface) {
+            $column = $column->asString();
+        }
+
         if (is_string($column)) {
             $column = $this->schema->getColumnFactory()->fromDefinition($column);
         }
@@ -353,6 +357,11 @@ public function dropView(string $viewName): string
         return $this->ddlBuilder->dropView($viewName);
     }
 
+    public function getColumnDefinitionBuilder(): ColumnDefinitionBuilderInterface
+    {
+        return $this->columnDefinitionBuilder;
+    }
+
     /** @deprecated Use {@see buildColumnDefinition()}. Will be removed in version 2.0. */
     public function getColumnType(ColumnInterface|string $type): string
     {

diff --git a/src/QueryBuilder/ColumnDefinitionBuilderInterface.php b/src/QueryBuilder/ColumnDefinitionBuilderInterface.php
@@ -16,4 +16,9 @@ interface ColumnDefinitionBuilderInterface
      * @return string the column SQL definition.
      */
     public function build(ColumnSchemaInterface $column): string;
+
+    /**
+     * Builds column definition for `ALTER` operation based on given column instance.
+     */
+    public function buildAlter(ColumnSchemaInterface $column): string;
 }
diff --git a/src/QueryBuilder/DDLQueryBuilderInterface.php b/src/QueryBuilder/DDLQueryBuilderInterface.php
@@ -10,6 +10,7 @@
 use Yiisoft\Db\Exception\NotSupportedException;
 use Yiisoft\Db\Query\QueryInterface;
 use Yiisoft\Db\Schema\Builder\ColumnInterface;
+use Yiisoft\Db\Schema\Column\ColumnSchemaInterface;
 
 /**
  * Defines methods for building SQL statements for DDL (data definition language).
@@ -36,7 +37,7 @@ public function addCheck(string $table, string $name, string $expression): strin
      *
      * @param string $table The table to add the new column will to.
      * @param string $column The name of the new column.
-     * @param ColumnInterface|string $type The column type.
+     * @param ColumnInterface|ColumnSchemaInterface|string $type The column type.
      * {@see getColumnType()} Method will be invoked to convert an abstract column type (if any) into the physical one.
      * Anything that isn't recognized as an abstract type will be kept in the generated SQL.
      * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become
@@ -46,7 +47,7 @@ public function addCheck(string $table, string $name, string $expression): strin
      *
      * Note: The method will quote the `table` and `column` parameters before using them in the generated SQL.
      */
-    public function addColumn(string $table, string $column, ColumnInterface|string $type): string;
+    public function addColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): string;
 
     /**
      * Builds an SQL command for adding comment to column.
@@ -159,7 +160,7 @@ public function addUnique(string $table, string $name, array|string $columns): s
      *
      * @param string $table The table whose column is to change.
      * @param string $column The name of the column to change.
-     * @param ColumnInterface|string $type The new column type.
+     * @param ColumnInterface|ColumnSchemaInterface|string $type The new column type.
      * {@see getColumnType()} Method will be invoked to convert an abstract column type (if any) into the physical one.
      * Anything that isn't recognized as an abstract type will be kept in the generated SQL.
      * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become
@@ -169,7 +170,7 @@ public function addUnique(string $table, string $name, array|string $columns): s
      *
      * Note: The method will quote the `table` and `column` parameters before using them in the generated SQL.
      */
-    public function alterColumn(string $table, string $column, ColumnInterface|string $type): string;
+    public function alterColumn(string $table, string $column, ColumnInterface|ColumnSchemaInterface|string $type): string;
 
     /**
      * Builds an SQL statement for enabling or disabling integrity check.
@@ -233,14 +234,14 @@ public function createIndex(
      *
      * @param string $table The name of the table to create.
      * @param array $columns The columns (name => definition) in the new table.
-     * The definition can be `string` or {@see ColumnInterface} instance.
+     * The definition can be `string` or {@see ColumnInterface} or {@see ColumnSchemaInterface} instance.
      * @param string|null $options More SQL fragments to append to the generated SQL.
      *
      * @return string The SQL statement for creating a new DB table.
      *
      * Note: The method will quote the `table` and `columns` parameter before using it in the generated SQL.
      *
-     * @psalm-param array<string, ColumnInterface>|string[] $columns
+     * @psalm-param array<string, ColumnInterface|ColumnSchemaInterface>|string[] $columns
      */
     public function createTable(string $table, array $columns, string $options = null): string;
 

diff --git a/src/QueryBuilder/QueryBuilderInterface.php b/src/QueryBuilder/QueryBuilderInterface.php
@@ -41,12 +41,12 @@ public function bindParam(mixed $value, array &$params = []): string;
     /**
      * Builds column definition based on given column instance.
      *
-     * @param ColumnSchemaInterface|string $column the column instance or string column definition which should be
-     * converted into a database string representation.
+     * @param ColumnInterface|ColumnSchemaInterface|string $column the column instance or string column definition which
+     * should be converted into a database string representation.
      *
      * @return string the SQL column definition.
      */
-    public function buildColumnDefinition(ColumnSchemaInterface|string $column): string;
+    public function buildColumnDefinition(ColumnInterface|ColumnSchemaInterface|string $column): string;
 
     /**
      * Converts an abstract column type into a physical column type.
@@ -98,6 +98,11 @@ public function buildColumnDefinition(ColumnSchemaInterface|string $column): str
      */
     public function getColumnType(ColumnInterface|string $type): string;
 
+    /**
+     * Returns the column definition builder for the current DBMS.
+     */
+    public function getColumnDefinitionBuilder(): ColumnDefinitionBuilderInterface;
+
     /**
      * Gets an object of {@see ExpressionBuilderInterface} that's suitable for $expression.
      *

diff --git a/src/Schema/Builder/AbstractColumn.php b/src/Schema/Builder/AbstractColumn.php
@@ -8,6 +8,7 @@
 use Yiisoft\Db\Constant\PseudoType;
 use Yiisoft\Db\Expression\Expression;
 use Yiisoft\Db\Helper\DbStringHelper;
+use Yiisoft\Db\Schema\Column\AbstractColumnSchema;
 
 use function gettype;
 use function implode;
@@ -27,6 +28,8 @@
  *
  * 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.
+ *
+ * @deprecated Use {@see AbstractColumnSchema} instead. Will be removed in 2.0.0.
  */
 abstract class AbstractColumn implements ColumnInterface
 {

diff --git a/tests/AbstractQueryBuilderTest.php b/tests/AbstractQueryBuilderTest.php
@@ -71,7 +71,7 @@ public function testAddColumn(ColumnInterface|string $type): void
             DbHelper::replaceQuotes(
                 <<<SQL
                 ALTER TABLE [[table]] ADD [[column]]
-                SQL . ' ' . $qb->getColumnType($type),
+                SQL . ' ' . $qb->buildColumnDefinition($type),
                 $db->getDriverName(),
             ),
             $sql,
@@ -192,22 +192,12 @@ public function testAddUnique(string $name, string $table, array|string $columns
         $this->assertSame($expected, $sql);
     }
 
-    public function testAlterColumn(): void
+    #[DataProviderExternal(QueryBuilderProvider::class, 'alterColumn')]
+    public function testAlterColumn(string|ColumnSchemaInterface $type, string $expected): void
     {
-        $db = $this->getConnection();
-
-        $qb = $db->getQueryBuilder();
-        $sql = $qb->alterColumn('customer', 'email', ColumnType::STRING);
+        $qb = $this->getConnection()->getQueryBuilder();
 
-        $this->assertSame(
-            DbHelper::replaceQuotes(
-                <<<SQL
-                ALTER TABLE [[customer]] CHANGE [[email]] [[email]]
-                SQL . ' ' . $qb->getColumnType(ColumnType::STRING),
-                $db->getDriverName(),
-            ),
-            $sql,
-        );
+        $this->assertSame($expected, $qb->alterColumn('foo1', 'bar', $type));
     }
 
     /**