【Laravel】マイグレーションとは（migration）：テーブル作成について

バージョン管理と履歴管理

マイグレーションはデータベース構造のバージョン管理をサポートします。データベースのテーブル作成やカラムの追加・変更・削除といった変更履歴を記録・管理します。

SQLでテーブル作成を行った場合、なにも記録は残りませんが、マイグレーションではファイルが残るため履歴管理やこの後説明するロールバックなどを可能にしています。

すべてのデータベースシステムで利用可能

Laravelのマイグレーションはすべてのデータベース（MySQLやSQLite、PostgreSQL、SQL Serverなど）で利用できます。

データベース環境によりコードを変更する必要がありません。

ロールバックが簡単

マイグレーションファイルを作成すると、ロールバックするためのメソッドが自動的に追加されます。そのためロールバックコマンドを実行するだけで簡単にロールバックが可能です。

ロールバックを実行すると実行していたマイグレーションは保留状態に戻るため、再度マイグレーションを実行することもできます。

データベーススキーマの可読性が高い

マイグレーションのコードはPHPで記述されており読みやすく、データベーススキーマについてわかりやすいコードで表されています。そのため可読性が高く、一目で理解できるようになっています。

データベーススキーマの変更に関してもマイグレーションファイル内のコードで表現されているため、ファイルの中身を見ることで明確になります。

ファイルの共有によりチーム全員が同一テーブルを作成できる

マイグレーションファイルをチーム内で共有し、各人がマイグレーションを実行することで簡単に全員が同じテーブルを持つデータベースを作成することができます。

学習コストが若干高い

マイグレーションについて完全に理解するには多少の時間がかかります。初めてフレームワークによる開発を行う方にとっては学習コストがかかる傾向があります。

１．マイグレーションファイルの作成

まず始めにマイグレーションファイルを作成します。マイグレーションファイルはテーブルの作成やカラムの追加・変更・削除といった操作を行う際に作成します。

ここでは新規でテーブルを作成するためのマイグレーションファイルを作成していきます。マイグレーションファイルの作成には以下構文に沿ったartisanコマンドを実行します。

指定するファイル名はスネークケース（単語をアンダーラインで繋ぐ）を使った「create_XXX_table」とすることでテーブルを新規追加するための記述が追加された状態でマイグレーションファイルが作成されます。

ここではbooksテーブルを作成するので次のようにコマンドを記述して実行します。

php artisan make:migration create_books_table

上記コマンドを実行すると「database/migrations」フォルダにマイグレーションファイルが作成されます。ファイル名は「yyyy_mm_dd_xxxxx_create_books_table.php」です。

マイグレーションファイルの中身は次のようになっています。

<?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::create('books', function (Blueprint $table) {
            $table->id();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::dropIfExists('books');
    }
};

マイグレーションファイルの中にはupメソッドとdownメソッドがあるのがわかります。upメソッドでは新規に追加するテーブル定義や定義変更するカラムのスキーマを指定します。downメソッドにはupメソッドとは逆に戻す処理を指定します。

２．マイグレーションファイルの編集：テーブル定義

マイグレーションファイルでは「スキーマビルダ」という仕組みでテーブルの作成・編集を記述します。スキーマビルダはSchemaファザードで記述します。

upメソッドの中にはSchema::createメソッドが記述され、第一引数にはテーブル名、第二引数にはクロシージャが指定されています。テーブルを作成する際はこのSchema::create内にテーブル定義を記述していきます。

booksテーブルを作成するために次のようにマイグレーションファイルに追記します。

public function up(): void
{
    Schema::create('books', function (Blueprint $table) {
        $table->id();
        $table->string('name','200');    // 追記
        $table->string('author_name','100');    // 追記
        $table->integer('price');    // 追記
        $table->timestamps();
    });
}

上記ではテーブルのカラムとしてid、name、author_name、price、timestampsを定義しています。timestampsはデータ登録日時（created_at）と更新日時（updated_at）をカラムに追加します。

スキーマビルダで生成できるカラムタイプについて代表的なものを以下に記します。

関連する複数のテーブルを関連付けて利用する場合は外部キー制約を使用する必要があります。マイグレーションで外部キー制約を作成する方法は以下記事をご参照ください。

【Laravel】migration：外部キー制約とは

３．マイグレーションの実行

マイグレーションファイルにテーブル定義を記入したら、マイグレーションを実行します。マイグレーションの実行にはartisanのmigrateコマンドを実行します。

php artisan migrate

上記コマンドを実行することで、「database/migrations」内のまだデータベースに反映されていないマイグレーションファイルを一括で反映させます。

マイグレーションの状態を確認したい場合は以下コマンドを実行します。

php artisan migrate:status

実行すると以下のように現在のマイグレーションの状態が表示されます。実行済みのファイルはSTATUSがRANとなります。

  Migration name ...................................................................................... Batch / Status
  2014_10_12_000000_create_users_table ....................................................................... [1] Ran
  2014_10_12_100000_create_password_reset_tokens_table ....................................................... [1] Ran
  2019_08_19_000000_create_failed_jobs_table ................................................................. [1] Ran
  2019_12_14_000001_create_personal_access_tokens_table ...................................................... [1] Ran

migrate:rollbackコマンド：ロールバック

データベースをロールバック（実行前の状態に戻す）する場合は、以下ロールバックのコマンドを実行します。

php artisan migrate:rollback

Laravelのマイグレーション機能ではマイグレーションの実行状態をmigrationsテーブルで管理しているため、上記のようなロールバックなどを可能にしています。

データベースで以下SQLを実行するとmigrationsテーブルの中身が確認できますので、ぜひ確認してみてください。

mysql> select * from migrations;

migrate:resetコマンド

すべてのマイグレーションをすべて元に戻したい場合は以下リセットコマンドを実行してください。

php artisan migrate:reset

migrate:refreshコマンド

「migrate:refresh」コマンドはマイグレーションをすべて取り消して、再度一からマイグレーションを実行します。

php artisan migrate:refresh