Fix issue for alter column for x-db-type in Pgsql

src/lib/ColumnToCode.php

@@ -85,26 +85,39 @@ class ColumnToCode
      */
     private $alter;
 
+    /**
+     * @var bool
+     * Q. How does it differ from `$alter` and why it is needed?
+     * A. Pgsql alter column data type does not support NULL, DEFAULT etc value. We just have to provide new data type.
+     * NULL will be handled SET NULL/SET NOT NULL
+     * DEFAULT will be handled by SET DEFAULT ...
+     * This property is only used in Pgsql DB and for alter column data type cases
+     */
+    private $alterByXDbType;
+
     /**
      * ColumnToCode constructor.
      * @param \yii\db\Schema       $dbSchema
      * @param \yii\db\ColumnSchema $column
      * @param bool                 $fromDb (if from database we prefer column type for usage, from schema - dbType)
      * @param bool                 $alter (flag for resolve quotes that is different for create and alter)
      * @param bool                 $raw see @property $raw above for docs
+     * @param bool                 $alterByXDbType see @alterByXDbType $raw above for docs
      */
     public function __construct(
         Schema $dbSchema,
         ColumnSchema $column,
         bool $fromDb = false,
         bool $alter = false,
-        bool $raw = false
+        bool $raw = false,
+        bool $alterByXDbType = false
     ) {
         $this->dbSchema = $dbSchema;
         $this->column = $column;
         $this->fromDb = $fromDb;
         $this->alter = $alter;
         $this->raw = $raw;
+        $this->alterByXDbType = $alterByXDbType;
 
         // TODO docs why we use `property_exists()`
         if (property_exists($this->column, 'xDbType') && is_string($this->column->xDbType) && !empty($this->column->xDbType)) {
@@ -145,6 +158,9 @@ public function getCode(bool $quoted = false):string
         if (ApiGenerator::isMysql() && $this->isEnum()) {
             return $quoted ? '"' . str_replace("\'", "'", $code) . '"' : $code;
         }
+        if (ApiGenerator::isPostgres() && $this->alterByXDbType) {
+            return $quoted ? "'" . $this->rawParts['type'] . "'" : $this->rawParts['type'];
+        }
         return $quoted ? "'" . $code . "'" : $code;
     }
 
@@ -161,6 +177,10 @@ public function getAlterExpression(bool $addUsingExpression = false):string
                 .' USING "'.$this->column->name.'"::'.$this->typeWithoutSize($this->rawParts['type'])."'";
         }
 
+        if (ApiGenerator::isPostgres() && $this->alterByXDbType) {
+            return "'" . $this->rawParts['type'] . "'";
+        }
+
         return $this->isBuiltinType
             ? '$this->' . $this->fluentParts['type'].'->'.$this->fluentParts['nullable']
             : "'" . $this->rawParts['type'] . " ".$this->rawParts['nullable']."'";
@@ -329,6 +349,10 @@ private function resolve():void
      */
     private function getIsBuiltinType($type, $dbType)
     {
+        if (property_exists($this->column, 'xDbType') && is_string($this->column->xDbType) && !empty($this->column->xDbType)) {
+            return false;
+        }
+
         if ($this->isEnum() && ApiGenerator::isMariaDb()) {
             return false;
         }

src/lib/migrations/MigrationRecordBuilder.php

@@ -7,6 +7,7 @@
 
 namespace cebe\yii2openapi\lib\migrations;
 
+use cebe\yii2openapi\generator\ApiGenerator;
 use cebe\yii2openapi\lib\ColumnToCode;
 use Yii;
 use yii\db\ColumnSchema;
@@ -37,6 +38,9 @@ final class MigrationRecordBuilder
 
     public const ALTER_COLUMN = MigrationRecordBuilder::INDENT . "\$this->alterColumn('%s', '%s', %s);";
 
+    public const ALTER_COLUMN_RAW = MigrationRecordBuilder::INDENT . "\$this->db->createCommand(\"ALTER TABLE %s MODIFY %s %s\")->execute();";
+    public const ALTER_COLUMN_RAW_PGSQL = MigrationRecordBuilder::INDENT . "\$this->db->createCommand(\"ALTER TABLE %s ALTER COLUMN %s SET DATA TYPE %s\")->execute();";
+
     /**
      * @var \yii\db\Schema
      */
@@ -94,6 +98,10 @@ public function addColumn(string $tableAlias, ColumnSchema $column):string
      */
     public function addDbColumn(string $tableAlias, ColumnSchema $column):string
     {
+        if (property_exists($column, 'xDbType') && is_string($column->xDbType) && !empty($column->xDbType)) {
+            $converter = $this->columnToCode($column, true);
+            return sprintf(self::ADD_COLUMN_RAW, $tableAlias, $column->name, $converter->getCode());
+        }
         $converter = $this->columnToCode($column, true);
         return sprintf(self::ADD_COLUMN, $tableAlias, $column->name, $converter->getCode(true));
     }
@@ -103,6 +111,13 @@ public function addDbColumn(string $tableAlias, ColumnSchema $column):string
      */
     public function alterColumn(string $tableAlias, ColumnSchema $column):string
     {
+        if (property_exists($column, 'xDbType') && is_string($column->xDbType) && !empty($column->xDbType)) {
+            $converter = $this->columnToCode($column, true, false, true, true);
+            return sprintf(
+                ApiGenerator::isPostgres() ? self::ALTER_COLUMN_RAW_PGSQL : self::ALTER_COLUMN_RAW,
+                $tableAlias, $column->name, $converter->getCode()
+            );
+        }
         $converter = $this->columnToCode($column, true);
         return sprintf(self::ALTER_COLUMN, $tableAlias, $column->name, $converter->getCode(true));
     }
@@ -112,6 +127,15 @@ public function alterColumn(string $tableAlias, ColumnSchema $column):string
      */
     public function alterColumnType(string $tableAlias, ColumnSchema $column, bool $addUsing = false):string
     {
+        if (property_exists($column, 'xDbType') && is_string($column->xDbType) && !empty($column->xDbType)) {
+            $converter = $this->columnToCode($column, false, false, true, true);
+            return sprintf(
+                ApiGenerator::isPostgres() ? self::ALTER_COLUMN_RAW_PGSQL : self::ALTER_COLUMN_RAW,
+                $tableAlias,
+                $column->name,
+                rtrim(ltrim($converter->getAlterExpression($addUsing), "'"), "'")
+            );
+        }
         $converter = $this->columnToCode($column, false);
         return sprintf(self::ALTER_COLUMN, $tableAlias, $column->name, $converter->getAlterExpression($addUsing));
     }
@@ -121,6 +145,15 @@ public function alterColumnType(string $tableAlias, ColumnSchema $column, bool $
      */
     public function alterColumnTypeFromDb(string $tableAlias, ColumnSchema $column, bool $addUsing = false) :string
     {
+        if (property_exists($column, 'xDbType') && is_string($column->xDbType) && !empty($column->xDbType)) {
+            $converter = $this->columnToCode($column, true, false, true, true);
+            return sprintf(
+                ApiGenerator::isPostgres() ? self::ALTER_COLUMN_RAW_PGSQL : self::ALTER_COLUMN_RAW,
+                $tableAlias,
+                $column->name,
+                rtrim(ltrim($converter->getAlterExpression($addUsing), "'"), "'")
+            );
+        }
         $converter = $this->columnToCode($column, true);
         return sprintf(self::ALTER_COLUMN, $tableAlias, $column->name, $converter->getAlterExpression($addUsing));
     }
@@ -225,9 +258,22 @@ public function dropIndex(string $tableAlias, string $indexName):string
     /**
      * @throws \yii\base\InvalidConfigException
      */
-    private function columnToCode(ColumnSchema $column, bool $fromDb = false, bool $alter = false): ColumnToCode
+    private function columnToCode(
+        ColumnSchema $column,
+        bool $fromDb = false,
+        bool $alter = false,
+        bool $raw = false,
+        bool $alterByXDbType = false
+    ): ColumnToCode
     {
-        return Yii::createObject(ColumnToCode::class, [$this->dbSchema, $column, $fromDb, $alter]);
+        return Yii::createObject(ColumnToCode::class, [
+            $this->dbSchema,
+            $column,
+            $fromDb,
+            $alter,
+            $raw,
+            $alterByXDbType
+        ]);
     }
 
     // public static function bnm789() // TODO rename

tests/specs/blog_v2/migrations_pgsql_db/m200000_000004_change_table_v2_users.php

@@ -10,7 +10,7 @@ public function safeUp()
         $this->addColumn('{{%v2_users}}', 'login', $this->text()->notNull());
         $this->dropColumn('{{%v2_users}}', 'username');
         $this->alterColumn('{{%v2_users}}', 'created_at', "DROP DEFAULT");
-        $this->alterColumn('{{%v2_users}}', 'email', 'varchar(255) NOT NULL');
+        $this->db->createCommand("ALTER TABLE {{%v2_users}} ALTER COLUMN email SET DATA TYPE varchar(255)")->execute();
         $this->dropIndex('v2_users_username_key', '{{%v2_users}}');
         $this->createIndex('v2_users_login_key', '{{%v2_users}}', 'login', true);
         $this->createIndex('v2_users_flags_hash_index', '{{%v2_users}}', 'flags', 'hash');

tests/specs/x_db_type/fresh/pgsql/x_db_type_pgsql.yaml

@@ -478,6 +478,8 @@ components:
         json_col:
           type: string
           x-db-type: text
+          nullable: false
+          default: fox jumps over dog
         numeric_col:
           type: string
           x-db-type: double precision

tests/specs/x_db_type/new_column/maria/app/migrations_maria_db/m200000_000000_create_table_alldbdatatypes.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * Table for Alldbdatatype
+ */
+class m200000_000000_create_table_alldbdatatypes extends \yii\db\Migration
+{
+    public function up()
+    {
+        $this->createTable('{{%alldbdatatypes}}', [
+            'id' => $this->bigPrimaryKey(),
+            0 => 'string_col varchar(255) NULL DEFAULT NULL',
+            1 => 'varchar_col varchar(132) NULL DEFAULT NULL',
+            2 => 'text_col text NULL DEFAULT NULL',
+            3 => 'varchar_4_col varchar(4) NULL DEFAULT NULL',
+            4 => 'char_4_col char(4) NULL DEFAULT NULL',
+            5 => 'char_5_col char NULL DEFAULT NULL',
+            6 => 'char_6_col char NOT NULL',
+            7 => 'char_7_col char(6) NOT NULL',
+            8 => 'char_8_col char NULL DEFAULT \'d\'',
+            9 => 'decimal_col decimal(12,3) NULL DEFAULT NULL',
+            10 => 'varbinary_col varbinary(5) NULL DEFAULT NULL',
+            11 => 'blob_col blob NULL DEFAULT NULL',
+            12 => 'bit_col bit NULL DEFAULT NULL',
+            13 => 'bit_2 bit(1) NULL DEFAULT NULL',
+            14 => 'bit_3 bit(64) NULL DEFAULT NULL',
+            15 => 'ti tinyint NULL DEFAULT NULL',
+            16 => 'ti_2 tinyint(1) NULL DEFAULT NULL',
+            17 => 'ti_3 tinyint(2) NULL DEFAULT NULL',
+            18 => 'si_col smallint NULL DEFAULT NULL',
+            19 => 'si_col_2 smallint unsigned zerofill NULL DEFAULT NULL',
+            20 => 'mi mediumint(10) unsigned zerofill comment "comment" NULL DEFAULT 7',
+            21 => 'bi bigint NULL DEFAULT NULL',
+            22 => 'int_col int NULL DEFAULT NULL',
+            23 => 'int_col_2 integer NULL DEFAULT NULL',
+            24 => 'numeric_col numeric NULL DEFAULT NULL',
+            25 => 'float_col float NULL DEFAULT NULL',
+            26 => 'float_2 float(10, 2) NULL DEFAULT NULL',
+            27 => 'float_3 float(8) NULL DEFAULT NULL',
+            28 => 'double_col double NULL DEFAULT NULL',
+            29 => 'double_p double precision(10,2) NULL DEFAULT NULL',
+            30 => 'double_p_2 double precision NULL DEFAULT NULL',
+            31 => 'real_col real NULL DEFAULT NULL',
+            32 => 'date_col date NULL DEFAULT NULL',
+            33 => 'time_col time NULL DEFAULT NULL',
+            34 => 'datetime_col datetime NULL DEFAULT NULL',
+            35 => 'timestamp_col timestamp NULL DEFAULT NULL',
+            36 => 'year_col year NULL DEFAULT NULL',
+            37 => 'json_col json NOT NULL',
+            38 => 'blob_def blob NULL DEFAULT \'the blob\'',
+            39 => 'text_def text NULL DEFAULT \'the text\'',
+            40 => 'json_def json NOT NULL DEFAULT \'{"a":"b"}\'',
+        ]);
+    }
+
+    public function down()
+    {
+        $this->dropTable('{{%alldbdatatypes}}');
+    }
+}

tests/specs/x_db_type/new_column/maria/app/migrations_maria_db/m200000_000001_create_table_editcolumns.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * Table for Editcolumn
+ */
+class m200000_000001_create_table_editcolumns extends \yii\db\Migration
+{
+    public function up()
+    {
+        $this->createTable('{{%editcolumns}}', [
+            'id' => $this->primaryKey(),
+            0 => 'name varchar(255) NOT NULL DEFAULT \'Horse-2\'',
+            'tag' => $this->text()->null()->defaultValue(null),
+            1 => 'first_name varchar(255) NULL DEFAULT NULL',
+            'string_col' => $this->text()->null()->defaultValue(null),
+            2 => 'dec_col decimal(12,2) NULL DEFAULT 3.14',
+            3 => 'str_col_def varchar(3) NOT NULL',
+            4 => 'json_col text NULL DEFAULT NULL',
+            5 => 'numeric_col double precision NULL DEFAULT NULL',
+        ]);
+    }
+
+    public function down()
+    {
+        $this->dropTable('{{%editcolumns}}');
+    }
+}

tests/specs/x_db_type/new_column/maria/app/migrations_maria_db/m200000_000002_change_table_newcolumns.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * Table for Newcolumn
+ */
+class m200000_000002_change_table_newcolumns extends \yii\db\Migration
+{
+    public function up()
+    {
+        $this->db->createCommand("ALTER TABLE {{%newcolumns}} ADD COLUMN dec_col decimal(12,4) NULL DEFAULT NULL")->execute();
+        $this->db->createCommand("ALTER TABLE {{%newcolumns}} ADD COLUMN json_col json NOT NULL")->execute();
+        $this->addColumn('{{%newcolumns}}', 'last_name', $this->text()->null()->defaultValue(null));
+        $this->db->createCommand("ALTER TABLE {{%newcolumns}} ADD COLUMN numeric_col double precision NULL DEFAULT NULL")->execute();
+        $this->db->createCommand("ALTER TABLE {{%newcolumns}} ADD COLUMN varchar_col varchar(5) NULL DEFAULT NULL")->execute();
+    }
+
+    public function down()
+    {
+        $this->dropColumn('{{%newcolumns}}', 'varchar_col');
+        $this->dropColumn('{{%newcolumns}}', 'numeric_col');
+        $this->dropColumn('{{%newcolumns}}', 'last_name');
+        $this->dropColumn('{{%newcolumns}}', 'json_col');
+        $this->dropColumn('{{%newcolumns}}', 'dec_col');
+    }
+}

tests/specs/x_db_type/new_column/maria/app/migrations_maria_db/m200000_000003_create_table_pristines.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * Table for Pristine
+ */
+class m200000_000003_create_table_pristines extends \yii\db\Migration
+{
+    public function up()
+    {
+        $this->createTable('{{%pristines}}', [
+            0 => 'custom_id_col integer primary key auto_increment NOT NULL',
+            1 => 'name text NOT NULL',
+            'tag' => $this->text()->null()->defaultValue("4 leg"),
+            2 => 'new_col varchar(17) NULL DEFAULT NULL',
+            3 => 'col_5 decimal(12,4) NULL DEFAULT NULL',
+            4 => 'col_6 decimal(11,2) NULL DEFAULT NULL',
+            5 => 'col_7 decimal(10,2) NULL DEFAULT NULL',
+            6 => 'col_8 json NOT NULL',
+            7 => 'col_9 varchar(9) NULL DEFAULT NULL',
+            8 => 'col_10 varchar(10) NULL DEFAULT NULL',
+            9 => 'col_11 text NULL DEFAULT NULL',
+        ]);
+    }
+
+    public function down()
+    {
+        $this->dropTable('{{%pristines}}');
+    }
+}

tests/specs/x_db_type/new_column/mysql/app/migrations_mysql_db/m200000_000000_create_table_alldbdatatypes.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * Table for Alldbdatatype
+ */
+class m200000_000000_create_table_alldbdatatypes extends \yii\db\Migration
+{
+    public function up()
+    {
+        $this->createTable('{{%alldbdatatypes}}', [
+            'id' => $this->bigPrimaryKey(),
+            0 => 'string_col varchar(255) NULL DEFAULT NULL',
+            1 => 'varchar_col varchar(132) NULL DEFAULT NULL',
+            2 => 'text_col text NULL',
+            3 => 'varchar_4_col varchar(4) NULL DEFAULT NULL',
+            4 => 'char_4_col char(4) NULL DEFAULT NULL',
+            5 => 'char_5_col char NULL DEFAULT NULL',
+            6 => 'char_6_col char NOT NULL',
+            7 => 'char_7_col char(6) NOT NULL',
+            8 => 'char_8_col char NULL DEFAULT \'d\'',
+            9 => 'decimal_col decimal(12,3) NULL DEFAULT NULL',
+            10 => 'varbinary_col varbinary(5) NULL DEFAULT NULL',
+            11 => 'blob_col blob NULL',
+            12 => 'bit_col bit NULL DEFAULT NULL',
+            13 => 'bit_2 bit(1) NULL DEFAULT NULL',
+            14 => 'bit_3 bit(64) NULL DEFAULT NULL',
+            15 => 'ti tinyint NULL DEFAULT NULL',
+            16 => 'ti_2 tinyint(1) NULL DEFAULT NULL',
+            17 => 'ti_3 tinyint(2) NULL DEFAULT NULL',
+            18 => 'si_col smallint NULL DEFAULT NULL',
+            19 => 'si_col_2 smallint unsigned zerofill NULL DEFAULT NULL',
+            20 => 'mi mediumint(10) unsigned zerofill comment "comment" NULL DEFAULT 7',
+            21 => 'bi bigint NULL DEFAULT NULL',
+            22 => 'int_col int NULL DEFAULT NULL',
+            23 => 'int_col_2 integer NULL DEFAULT NULL',
+            24 => 'numeric_col numeric NULL DEFAULT NULL',
+            25 => 'float_col float NULL DEFAULT NULL',
+            26 => 'float_2 float(10, 2) NULL DEFAULT NULL',
+            27 => 'float_3 float(8) NULL DEFAULT NULL',
+            28 => 'double_col double NULL DEFAULT NULL',
+            29 => 'double_p double precision(10,2) NULL DEFAULT NULL',
+            30 => 'double_p_2 double precision NULL DEFAULT NULL',
+            31 => 'real_col real NULL DEFAULT NULL',
+            32 => 'date_col date NULL DEFAULT NULL',
+            33 => 'time_col time NULL DEFAULT NULL',
+            34 => 'datetime_col datetime NULL DEFAULT NULL',
+            35 => 'timestamp_col timestamp NULL DEFAULT NULL',
+            36 => 'year_col year NULL DEFAULT NULL',
+            37 => 'json_col json NOT NULL',
+            38 => 'blob_def blob NULL',
+            39 => 'text_def text NULL',
+            40 => 'json_def json NOT NULL',
+        ]);
+    }
+
+    public function down()
+    {
+        $this->dropTable('{{%alldbdatatypes}}');
+    }
+}