【Laravel】マイグレーション：既存テーブルにカラムを追加・変更・削除する

既存デーブルにカラムを追加する方法

既存テーブルにカラムを追加する場合は以下の流れで操作を行います。

1. カラム追加用のマイグレーションファイルの作成
2. マイグレーションファイルの編集
3. マイグレーションファイルの実行

カラム追加用のマイグレーションファイルの作成

artisanコマンドを使ってカラム追加用のマイグレーションファイルを作成します。以下構文に沿ってコマンドを実行しましょう。

ファイル名にあたる「add_カラム名_to_テーブル名_table」はどのような名前でも大丈夫です。ただわかりやすいように、なんのフィールドをどこのテーブルに追加するのかがわかる名前にしましょう。

--tableオプションではどのテーブルに対するマイグレーションファイルなのかを指定しています。

例えばusersテーブルにdepartmentカラムを追加する場合は次のようなコマンドになります。

> php artisan make:migration add_department_to_users_table –table=users
…
created successfully.

上記コマンドを実行することで「database/migrations」フォルダにマイグレーションファイルが作成されます。生成されたマイグレーションファイルの中身は次の通りです。

<?php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::table('users', function (Blueprint $table) {
            //
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::table('users', function (Blueprint $table) {
            //
        });
    }
};

マイグレーションファイルの編集

次に生成されたマイグレーションファイルにカラムを追加するコードを記述していきます。以下のようにupメソッドにカラムを追加するコード、downメソッドにカラムを削除するコードをそれぞれ記述します。

public function up()
{
    Schema::table('users', function (Blueprint $table) {
        $table->string('department')->nullable();
    });
}

public function down()
{
    Schema::table('users', function (Blueprint $table) {
        $table->dropColumn('department');
    });
}

マイグレーションファイルの実行

最後にマイグレーションを実行してテーブルにカラムを追加します。

php artisan migrate

上記のコマンドを実行することでマイグレーションが実行され、カラムがテーブルに追加されます。

既存テーブルからカラムを削除する方法

既存テーブルからカラムを削除する場合は以下の流れで操作を行います。

1. カラム削除用のマイグレーションファイルの作成
2. マイグレーションファイルの編集
3. マイグレーションファイルの実行

カラム削除用のマイグレーションファイルの作成

artisanコマンドを使ってカラム削除用のマイグレーションファイルを作成します。以下構文に沿ってコマンドを実行しましょう。

ファイル名にあたる「delete_カラム名_from_テーブル名_table」はどのような名前でも大丈夫です。ただわかりやすいように、なんのフィールドをどこのテーブルから削除するのかがわかる名前にしましょう。

例えばusersテーブルからdepartmentカラムを削除する場合は次のようなコマンドになります。

> php artisan make:migration delete_department_from_users_table –table=users
…
created successfully.

上記のコマンドでカラム削除用のマイグレーションファイルが生成されます。

マイグレーションファイルの編集

次に生成されたマイグレーションファイルにカラムを削除するコードを記述していきます。以下のようにupメソッドにカラムを削除するコード、downメソッドにカラムを再生成するコードをそれぞれ記述します。

public function up()
{
    Schema::table('users', function (Blueprint $table) {
        $table->dropColumn('department');
    });
}

public function down()
{
    Schema::table('users', function (Blueprint $table) {
        $table->string('department')->nullable();
    });
}

マイグレーションファイルの実行

最後に以下のコマンドを実行してカラムの削除をテーブルに適用します。

php artisan migrate

既存テーブルのカラム（データ型や長さ）を変更する方法

既存テーブルのカラムを編集する場合でもマイグレーションを利用します。例えばカラムのデータ型を変更する、長さを変更する、デフォルト値を設定するといった場合です。

既存テーブルのカラムを編集する流れは以下の通りです。

1. doctrine/dbalパッケージをプロジェクトにインストール
2. カラム編集用のマイグレーションファイルを作成
3. マイグレーションファイルを編集
4. マイグレーションファイルの実行

doctrine/dbalパッケージをプロジェクトにインストール

Laravelで既存テーブルのカラムを編集する場合は「doctrine/dbal」パッケージをLaravelプロジェクトにインストールする必要があります。

doctrine/dbalパッケージのインストールにはプロジェクトで以下コマンドを実行します。

composer require doctrine/dbal

カラム変更用のマイグレーションファイルを作成

artisanコマンドを使ってカラム変更用のマイグレーションファイルを作成します。以下構文に沿ってコマンドを実行しましょう。

ファイル名にあたる「change_カラム名_in_テーブル名_table」はどのような名前でも大丈夫です。ただわかりやすいように、なんのフィールドをどこのテーブルから変更するのかがわかる名前にしましょう。

例えばusersテーブルからdepartmentカラムの長さを変更する場合は次のようなコマンドになります。

> php artisan make:migration change_department_length_in_users_table –table=users
…
created successfully.

マイグレーションファイルを編集

次に生成されたマイグレーションファイルにカラムを変更するコードを記述していきます。以下のようにupメソッドにカラムを変更するコード、downメソッドにカラムを変更前に戻すコードをそれぞれ記述します。

以下ではusersテーブルのdepartmentカラムの長さを10から20に変更しています。

public function up()
{
    Schema::table('users', function (Blueprint $table) {
        $table->string('department', 20)->change();
    });
}

public function down()
{
    Schema::table('users', function (Blueprint $table) {
        $table->string('department', 10)->change();
    });
}

カラムのデータ型を変更する場合は次のように記述します。

public function up()
{
    Schema::table('users', function (Blueprint $table) {
        $table->text('department')->change();
    });
}

public function down()
{
    Schema::table('users', function (Blueprint $table) {
        $table->string('department')->change();
    });
}

マイグレーションファイルの実行

最後に以下のコマンドを実行してカラムの変更をテーブルに適用します。

php artisan migrate