【Laravel】migration にて、カラムの型を enum に change できない。

July 27, 2021 • ☕️ 5 min read

【環境】
Laravel のバージョン： 8.16.1
PHP のバージョン： 7.4.7
MySQL のバージョン： 5.7

Laravel にて、migration ファイルにて DB のカラムの型を変えるコードを書き、migration をすると、エラーが発生する。

具体的には以下のようなコード。

    Schema::table('authors', function (Blueprint $table) {
        $table->enum('gender_type', [1, 2, 3])->nullable()->default(null)->change();
    });

出てきたエラーメッセージ、こんな感じ。

Unknown column type “enum” requested. Any Doctrine type that you use has to be registered with \Doctrine\DBAL\Types\Type::addType().

You can get a list of all the known types with \Doctrine\DBAL\Types\Type::getTypesMap(). If this error occurs during database

introspection then you might have forgotten to register all database types for a Doctrine Type.

Use AbstractPlatform#registerDoctrineTypeMapping() or have your custom types implement Type#getMappedDatabaseTypes().

If the type name is empty you might have a problem with the cache or forgot some mapping information.

どういう事じゃい。
と思って調べたら、こんなの出てきた。

どうやら、change() メソッドでカラムの型を enum に変更する事は出来ないみたい。

理由は、DBAL 2.9.2は列挙型データ型をサポートしていないからだそうです。

とのこと。

標準では不可、という事で、以下解決策。

解決策１．DB::statement を使い、Alter table を実行する

こんな感じ。

    DB::statement("ALTER TABLE authors MODIFY COLUMN gender_type ENUM('1', '2', '3')");

個人的には、なるべくやりたくない。
理由は、RDB個別の処理になるから。
RDB が MySQL → Postgres に変わってしまった場合、動かないコードが出来てしまう。

なので、エラーが発生しないようにするためには、以下のように RDB による制限が必要となってしまう。
例えば、こんな感じ。

    public function up()
    {
        // MySQL 出なかった場合、早期リターンして、Alter table コマンド（RDB固有のコマンド）を実行しない
        if (DB::getDriverName() !== 'mysql') {
            return;
        }

        DB::statement("ALTER TABLE authors MODIFY COLUMN gender_type ENUM('1', '2', '3')");
    }