Migrations: Support ENUM field

[saada]

ENUM("ONE", "TWO", "THREE") NOT NULL'

should be supported via

$this->enum(['ONE', 'TWO', 'THREE'])->notNull();

Funding

• You can sponsor this specific effort via a Polar.sh pledge below
• We receive the pledge once the issue is completed & verified

[usualdesigner]

+1

[wbraganca]

+1

[samdark]

Is enum supported by all DBs that are supported in Yii?

[nineinchnick]

@samdark even if not directly supported by a db, adding a check constraint to limit values makes it look like an enum:

ALTER TABLE table ADD CONSTRAINT enum_col CHECK (enum_col IN ('value1', 'value2'));

CHECK constraints should be supported by most dbs, even SQLite.

[nineinchnick]

The drawback is that such a CHECK constraint won't be detected as an enum when Yii loads the schema and populates \yii\db\Column::$enumValues.

[samdark]

So Gii won't be able to generate based on such checks. And since we don't have it in schema we won't be able to work with these in a good way...

[nineinchnick]

We could have only one supported syntax and detect it, like the example i've posted above. I've already done detecting literal values when parsing column defaults in #9773.

[nineinchnick]

I actually use such CHECK syntax often and would be interested if it gets detected, because now I have to add it in the model manually.

[saada]

It would be great to have support for an API like

$this->addEnumValue($tableName, $columnName, ['NEW_ENUM_VALUE']);
$this->removeEnumValue($tableName, $columnName, ['NEW_ENUM_VALUE']);

[gitowiec]

+1

[saada]

The biggest challenge with adding/removing ENUM values from a column is migrating old records to the new values. Maybe that should be the responsibility of the developer to write the proper updateAll() statements in their migration?

[arren-ru]

I assume that adding a default value can solve the problem with the data migration.
Another way is to migrate by adding a new values, doing some changes after that, and finally removing unnecessary values from enum.

[kiironoaki]

+1

[dignityinside]

+1

[tommyknocker]

+1

[SilverFire]

We are glad to accept a pull request with the suggested enhancement

[newerton]

+1

[planet17]

+1

[paulocoutinhox]

+1

[harsiddhi]

how to add default value in enum ??

[cebe]

ENUM('a', 'b', 'c') NOT NULL DEFAULT 'a'?

[designia]

+1

[santilin]

Is anyone working on this?

[samdark]

No.

[NetLS2013]

@samdark is this done?

[samdark]

No.

[tomaszkane]

I really want to have enum and set column type support :-)

[Radon8472]

Is this feature still in progress?

[samdark]

It is on hold.