Do not generate ENUM types on postgres if x-db-type is specified for the enum column

cebe · cebe · commit d13479f5a7e5 · 2024-05-27T15:28:14.000+02:00
fixes cebe#173
diff --git a/src/lib/ColumnToCode.php b/src/lib/ColumnToCode.php
@@ -226,7 +226,7 @@ public function isJson():bool
 
     public function isEnum():bool
     {
-        return !empty($this->column->enumValues);
+        return !empty($this->column->enumValues) && empty($this->column->xDbType);
     }
 
     public function isDecimal()
diff --git a/src/lib/migrations/BaseMigrationBuilder.php b/src/lib/migrations/BaseMigrationBuilder.php
@@ -479,7 +479,7 @@ public function newColStr(string $tableAlias, \cebe\yii2openapi\db\ColumnSchema
 
     public static function isEnum(\yii\db\ColumnSchema $columnSchema): bool
     {
-        if (!empty($columnSchema->enumValues) && is_array($columnSchema->enumValues)) {
+        if (!empty($columnSchema->enumValues) && is_array($columnSchema->enumValues) && empty($columnSchema->xDbType)) {
             return true;
         }
         return false;
diff --git a/src/lib/migrations/PostgresMigrationBuilder.php b/src/lib/migrations/PostgresMigrationBuilder.php
@@ -147,6 +147,10 @@ protected function createEnumMigrations():void
         $tableAlias = $this->model->getTableAlias();
         $enums = $this->model->getEnumAttributes();
         foreach ($enums as $attr) {
+            if (!empty($attr->xDbType)) {
+                // do not generate enum types when custom x-db-type is used
+                continue;
+            }
             $this->migration
                 ->addUpCode($this->recordBuilder->createEnum($tableAlias, $attr->columnName, $attr->enumValues), true)
                 ->addDownCode($this->recordBuilder->dropEnum($tableAlias, $attr->columnName), true);
diff --git a/tests/migrations/m100000_000000_pgsql.php b/tests/migrations/m100000_000000_pgsql.php
@@ -103,6 +103,7 @@ public function safeUp()
                 'json3' => $this->json()->defaultValue(Json::encode(['foo' => 'bar', 'bar' => 'baz'])),
                 'json4' => "json DEFAULT '" . new Expression(Json::encode(['ffo' => 'bar'])) . "'",
                 'status' => '"'.$enumTypeName.'"',
+                'status_x' => 'varchar(10)',
                 'search' => 'tsvector'
             ]);
         $columns = [
diff --git a/tests/specs/enum/change/maria/app/migrations_maria_db/m200000_000001_create_table_newcolumns.php b/tests/specs/enum/change/maria/app/migrations_maria_db/m200000_000001_create_table_newcolumns.php
@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 
diff --git a/tests/specs/enum/change/mysql/app/migrations_mysql_db/m200000_000001_create_table_newcolumns.php b/tests/specs/enum/change/mysql/app/migrations_mysql_db/m200000_000001_create_table_newcolumns.php
@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 
diff --git a/tests/specs/enum/change/pgsql/app/migrations_pgsql_db/m200000_000001_create_table_newcolumns.php b/tests/specs/enum/change/pgsql/app/migrations_pgsql_db/m200000_000001_create_table_newcolumns.php
@@ -11,6 +11,7 @@ public function safeUp()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => '"enum_itt_newcolumns_new_column" NOT NULL DEFAULT \'ONE\'',
+            0 => '"new_column_x" varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 
diff --git a/tests/specs/enum/fresh/maria/app/migrations_maria_db/m200000_000001_create_table_newcolumns.php b/tests/specs/enum/fresh/maria/app/migrations_maria_db/m200000_000001_create_table_newcolumns.php
@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 
diff --git a/tests/specs/enum/fresh/mysql/app/migrations_mysql_db/m200000_000001_create_table_newcolumns.php b/tests/specs/enum/fresh/mysql/app/migrations_mysql_db/m200000_000001_create_table_newcolumns.php
@@ -10,6 +10,7 @@ public function up()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',
+            0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 
diff --git a/tests/specs/enum/fresh/mysql/enum.yaml b/tests/specs/enum/fresh/mysql/enum.yaml
@@ -59,6 +59,16 @@ components:
           default:
             ONE
           nullable: false
+        new_column_x:
+          type: string
+          enum:
+            - ONE
+            - TWO
+            - THREE
+          default:
+            ONE
+          x-db-type: varchar(10)
+          nullable: false
 
     Editcolumn:
       type: object
diff --git a/tests/specs/enum/fresh/pgsql/app/migrations_pgsql_db/m200000_000001_create_table_newcolumns.php b/tests/specs/enum/fresh/pgsql/app/migrations_pgsql_db/m200000_000001_create_table_newcolumns.php
@@ -11,6 +11,7 @@ public function safeUp()
         $this->createTable('{{%newcolumns}}', [
             'id' => $this->primaryKey(),
             'new_column' => '"enum_itt_newcolumns_new_column" NOT NULL DEFAULT \'ONE\'',
+            0 => '"new_column_x" varchar(10) NOT NULL DEFAULT \'ONE\'',
         ]);
     }
 
diff --git a/tests/specs/enum/new_column/maria/app/migrations_maria_db/m200000_000001_change_table_newcolumns.php b/tests/specs/enum/new_column/maria/app/migrations_maria_db/m200000_000001_change_table_newcolumns.php
@@ -8,12 +8,14 @@ class m200000_000001_change_table_newcolumns extends \yii\db\Migration
     public function up()
     {
         $this->addColumn('{{%newcolumns}}', 'new_column', 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'');
+        $this->db->createCommand('ALTER TABLE {{%newcolumns}} ADD COLUMN new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'')->execute();
         $this->dropColumn('{{%newcolumns}}', 'delete_col');
     }
 
     public function down()
     {
         $this->addColumn('{{%newcolumns}}', 'delete_col', 'enum("FOUR", "FIVE", "SIX") NULL DEFAULT NULL');
+        $this->dropColumn('{{%newcolumns}}', 'new_column_x');
         $this->dropColumn('{{%newcolumns}}', 'new_column');
     }
 }
diff --git a/tests/specs/enum/new_column/mysql/app/migrations_mysql_db/m200000_000001_change_table_newcolumns.php b/tests/specs/enum/new_column/mysql/app/migrations_mysql_db/m200000_000001_change_table_newcolumns.php
@@ -7,13 +7,15 @@ class m200000_000001_change_table_newcolumns extends \yii\db\Migration
 {
     public function up()
     {
-        $this->addColumn('{{%newcolumns}}', 'new_column', 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'');
+        $this->addColumn('{{%newcolumns}}', 'new_column', 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\' AFTER id');
+        $this->db->createCommand('ALTER TABLE {{%newcolumns}} ADD COLUMN new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'')->execute();
         $this->dropColumn('{{%newcolumns}}', 'delete_col');
     }
 
     public function down()
     {
         $this->addColumn('{{%newcolumns}}', 'delete_col', 'enum("FOUR", "FIVE", "SIX") NULL DEFAULT NULL');
+        $this->dropColumn('{{%newcolumns}}', 'new_column_x');
         $this->dropColumn('{{%newcolumns}}', 'new_column');
     }
 }
diff --git a/tests/specs/enum/new_column/pgsql/app/migrations_pgsql_db/m200000_000001_change_table_newcolumns.php b/tests/specs/enum/new_column/pgsql/app/migrations_pgsql_db/m200000_000001_change_table_newcolumns.php
@@ -9,6 +9,7 @@ public function safeUp()
     {
         $this->execute('CREATE TYPE "enum_itt_newcolumns_new_column" AS ENUM(\'ONE\', \'TWO\', \'THREE\')');
         $this->addColumn('{{%newcolumns}}', 'new_column', '"enum_itt_newcolumns_new_column" NOT NULL DEFAULT \'ONE\'');
+        $this->db->createCommand('ALTER TABLE {{%newcolumns}} ADD COLUMN new_column_x varchar(10) NOT NULL DEFAULT \'ONE\' AFTER id')->execute();
         $this->dropColumn('{{%newcolumns}}', 'delete_col');
         $this->execute('DROP TYPE "enum_itt_newcolumns_delete_col"');
     }
@@ -17,6 +18,7 @@ public function safeDown()
     {
         $this->execute('CREATE TYPE "enum_itt_newcolumns_delete_col" AS ENUM(\'FOUR\', \'FIVE\', \'SIX\')');
         $this->addColumn('{{%newcolumns}}', 'delete_col', '"enum_itt_newcolumns_delete_col" NULL DEFAULT NULL');
+        $this->dropColumn('{{%newcolumns}}', 'new_column_x');
         $this->dropColumn('{{%newcolumns}}', 'new_column');
         $this->execute('DROP TYPE "enum_itt_newcolumns_new_column"');
     }
diff --git a/tests/specs/postgres_custom.yaml b/tests/specs/postgres_custom.yaml
@@ -70,6 +70,13 @@ components:
                     enum:
                         - active
                         - draft
+                status_x:
+                    type: string
+                    default: draft
+                    enum:
+                        - active
+                        - draft
+                    x-db-type: varchar(10)
                 search:
                   type: string
                   x-db-type: tsvector
diff --git a/tests/specs/postgres_custom/migrations_pgsql_db/m200000_000000_change_table_v3_pgcustom.php b/tests/specs/postgres_custom/migrations_pgsql_db/m200000_000000_change_table_v3_pgcustom.php
@@ -16,6 +16,7 @@ public function safeUp()
         $this->alterColumn('{{%v3_pgcustom}}', 'json4', "SET NOT NULL");
         $this->alterColumn('{{%v3_pgcustom}}', 'json4', "SET DEFAULT '{\"foo\":\"bar\",\"bar\":\"baz\"}'");
         $this->alterColumn('{{%v3_pgcustom}}', 'status', "SET DEFAULT 'draft'");
+        $this->alterColumn('{{%v3_pgcustom}}', 'status_x', "SET DEFAULT 'draft'");
         $this->createIndex('v3_pgcustom_search_gin_index', '{{%v3_pgcustom}}', 'search', 'gin(to_tsvector(\'english\', status))');
     }
 
@@ -31,5 +32,6 @@ public function safeDown()
         $this->alterColumn('{{%v3_pgcustom}}', 'json4', "DROP NOT NULL");
         $this->alterColumn('{{%v3_pgcustom}}', 'json4', "SET DEFAULT '{\"ffo\":\"bar\"}'");
         $this->alterColumn('{{%v3_pgcustom}}', 'status', "DROP DEFAULT");
+        $this->alterColumn('{{%v3_pgcustom}}', 'status_x', "DROP DEFAULT");
     }
 }
diff --git a/tests/specs/postgres_custom/models/CustomFaker.php b/tests/specs/postgres_custom/models/CustomFaker.php
@@ -36,6 +36,7 @@ public function generateModel($attributes = [])
         $model->json3 = [];
         $model->json4 = [];
         $model->status = $faker->randomElement(['active','draft']);
+        $model->status_x = $faker->randomElement(['active','draft']);
         if (!is_callable($attributes)) {
             $model->setAttributes($attributes, false);
         } else {
diff --git a/tests/specs/postgres_custom/models/base/Custom.php b/tests/specs/postgres_custom/models/base/Custom.php
@@ -12,6 +12,7 @@
  * @property array $json3
  * @property array $json4
  * @property string $status
+ * @property string $status_x
  * @property string $search
  *
  */
@@ -25,7 +26,7 @@ public static function tableName()
     public function rules()
     {
         return [
-            'trim' => [['status'], 'trim'],
+            'trim' => [['status', 'status_x'], 'trim'],
             'num_integer' => [['num'], 'integer'],
             'num_default' => [['num'], 'default', 'value' => 0],
             'json1_default' => [['json1'], 'default', 'value' => []],
@@ -48,6 +49,12 @@ public function rules()
                 'draft',
             ]],
             'status_default' => [['status'], 'default', 'value' => 'draft'],
+            'status_x_string' => [['status_x'], 'string', 'max' => 10],
+            'status_x_in' => [['status_x'], 'in', 'range' => [
+                'active',
+                'draft',
+            ]],
+            'status_x_default' => [['status_x'], 'default', 'value' => 'draft'],
             'safe' => [['json1', 'json2', 'json3', 'json4'], 'safe'],
         ];
     }

Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ public function isJson():bool`
`226`	`226`
`227`	`227`	`public function isEnum():bool`
`228`	`228`	`{`
`229`		`- return !empty($this->column->enumValues);`
	`229`	`+ return !empty($this->column->enumValues) && empty($this->column->xDbType);`
`230`	`230`	`}`
`231`	`231`
`232`	`232`	`public function isDecimal()`
Original file line number	Diff line number	Diff line change
`@@ -479,7 +479,7 @@ public function newColStr(string $tableAlias, \cebe\yii2openapi\db\ColumnSchema`
`479`	`479`
`480`	`480`	`public static function isEnum(\yii\db\ColumnSchema $columnSchema): bool`
`481`	`481`	`{`
`482`		`- if (!empty($columnSchema->enumValues) && is_array($columnSchema->enumValues)) {`
	`482`	`+ if (!empty($columnSchema->enumValues) && is_array($columnSchema->enumValues) && empty($columnSchema->xDbType)) {`
`483`	`483`	`return true;`
`484`	`484`	`}`
`485`	`485`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ public function up()`
`10`	`10`	`$this->createTable('{{%newcolumns}}', [`
`11`	`11`	`'id' => $this->primaryKey(),`
`12`	`12`	`'new_column' => 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'',`
	`13`	`+ 0 => 'new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'',`
`13`	`14`	`]);`
`14`	`15`	`}`
`15`	`16`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ public function safeUp()`
`11`	`11`	`$this->createTable('{{%newcolumns}}', [`
`12`	`12`	`'id' => $this->primaryKey(),`
`13`	`13`	`'new_column' => '"enum_itt_newcolumns_new_column" NOT NULL DEFAULT \'ONE\'',`
	`14`	`+ 0 => '"new_column_x" varchar(10) NOT NULL DEFAULT \'ONE\'',`
`14`	`15`	`]);`
`15`	`16`	`}`
`16`	`17`
Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,14 @@ class m200000_000001_change_table_newcolumns extends \yii\db\Migration`
`8`	`8`	`public function up()`
`9`	`9`	`{`
`10`	`10`	`$this->addColumn('{{%newcolumns}}', 'new_column', 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'');`
	`11`	`+ $this->db->createCommand('ALTER TABLE {{%newcolumns}} ADD COLUMN new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'')->execute();`
`11`	`12`	`$this->dropColumn('{{%newcolumns}}', 'delete_col');`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`public function down()`
`15`	`16`	`{`
`16`	`17`	`$this->addColumn('{{%newcolumns}}', 'delete_col', 'enum("FOUR", "FIVE", "SIX") NULL DEFAULT NULL');`
	`18`	`+ $this->dropColumn('{{%newcolumns}}', 'new_column_x');`
`17`	`19`	`$this->dropColumn('{{%newcolumns}}', 'new_column');`
`18`	`20`	`}`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,15 @@ class m200000_000001_change_table_newcolumns extends \yii\db\Migration`
`7`	`7`	`{`
`8`	`8`	`public function up()`
`9`	`9`	`{`
`10`		`- $this->addColumn('{{%newcolumns}}', 'new_column', 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\'');`
	`10`	`+ $this->addColumn('{{%newcolumns}}', 'new_column', 'enum("ONE", "TWO", "THREE") NOT NULL DEFAULT \'ONE\' AFTER id');`
	`11`	`+ $this->db->createCommand('ALTER TABLE {{%newcolumns}} ADD COLUMN new_column_x varchar(10) NOT NULL DEFAULT \'ONE\'')->execute();`
`11`	`12`	`$this->dropColumn('{{%newcolumns}}', 'delete_col');`
`12`	`13`	`}`
`13`	`14`
`14`	`15`	`public function down()`
`15`	`16`	`{`
`16`	`17`	`$this->addColumn('{{%newcolumns}}', 'delete_col', 'enum("FOUR", "FIVE", "SIX") NULL DEFAULT NULL');`
	`18`	`+ $this->dropColumn('{{%newcolumns}}', 'new_column_x');`
`17`	`19`	`$this->dropColumn('{{%newcolumns}}', 'new_column');`
`18`	`20`	`}`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ public function safeUp()`
`9`	`9`	`{`
`10`	`10`	`$this->execute('CREATE TYPE "enum_itt_newcolumns_new_column" AS ENUM(\'ONE\', \'TWO\', \'THREE\')');`
`11`	`11`	`$this->addColumn('{{%newcolumns}}', 'new_column', '"enum_itt_newcolumns_new_column" NOT NULL DEFAULT \'ONE\'');`
	`12`	`+ $this->db->createCommand('ALTER TABLE {{%newcolumns}} ADD COLUMN new_column_x varchar(10) NOT NULL DEFAULT \'ONE\' AFTER id')->execute();`
`12`	`13`	`$this->dropColumn('{{%newcolumns}}', 'delete_col');`
`13`	`14`	`$this->execute('DROP TYPE "enum_itt_newcolumns_delete_col"');`
`14`	`15`	`}`
`@@ -17,6 +18,7 @@ public function safeDown()`
`17`	`18`	`{`
`18`	`19`	`$this->execute('CREATE TYPE "enum_itt_newcolumns_delete_col" AS ENUM(\'FOUR\', \'FIVE\', \'SIX\')');`
`19`	`20`	`$this->addColumn('{{%newcolumns}}', 'delete_col', '"enum_itt_newcolumns_delete_col" NULL DEFAULT NULL');`
	`21`	`+ $this->dropColumn('{{%newcolumns}}', 'new_column_x');`
`20`	`22`	`$this->dropColumn('{{%newcolumns}}', 'new_column');`
`21`	`23`	`$this->execute('DROP TYPE "enum_itt_newcolumns_new_column"');`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public function safeUp()`
`16`	`16`	`$this->alterColumn('{{%v3_pgcustom}}', 'json4', "SET NOT NULL");`
`17`	`17`	`$this->alterColumn('{{%v3_pgcustom}}', 'json4', "SET DEFAULT '{\"foo\":\"bar\",\"bar\":\"baz\"}'");`
`18`	`18`	`$this->alterColumn('{{%v3_pgcustom}}', 'status', "SET DEFAULT 'draft'");`
	`19`	`+ $this->alterColumn('{{%v3_pgcustom}}', 'status_x', "SET DEFAULT 'draft'");`
`19`	`20`	`$this->createIndex('v3_pgcustom_search_gin_index', '{{%v3_pgcustom}}', 'search', 'gin(to_tsvector(\'english\', status))');`
`20`	`21`	`}`
`21`	`22`
`@@ -31,5 +32,6 @@ public function safeDown()`
`31`	`32`	`$this->alterColumn('{{%v3_pgcustom}}', 'json4', "DROP NOT NULL");`
`32`	`33`	`$this->alterColumn('{{%v3_pgcustom}}', 'json4', "SET DEFAULT '{\"ffo\":\"bar\"}'");`
`33`	`34`	`$this->alterColumn('{{%v3_pgcustom}}', 'status', "DROP DEFAULT");`
	`35`	`+ $this->alterColumn('{{%v3_pgcustom}}', 'status_x', "DROP DEFAULT");`
`34`	`36`	`}`
`35`	`37`	`}`