【Laravel】複数のテーブルを1つのMigrationファイルにまとめる方法を解説

laravelアイキャッチ Laravel
2021.08.20

こんにちは、かつコーチです。

Laravelでは、通常Migrationするときに1つのテーブルに対して1つのMigrationです。

しかし、テーブルが増えてくると管理も大変になるので、同じようなものはまとめることができるのか、

それを実現するにはどうすれば良いのか、注意点は何かについて解説します。

複数のテーブルを1つのMigrationファイルにまとめることはできるのか？

まず、複数のテーブルを1つのMigrationファイルにまとめることは可能です。

特に関連するテーブルを一度に作成したい場合に便利です。

記述例

書き方の例は以下の通りです。

例: 通常時

// コースカテゴリーテーブル
return new class extends Migration
{
    public function up()
    {
        Schema::create('course_categories', function (Blueprint $table) {
            $table->id();
            $table->foreignId('store_id')->constrained();
            $table->string('name', 50)->comment('コースカテゴリー名');
            $table->text('description')->comment('コース概要');
            $table->string('course_photo_path')->nullable()->comment('コース画像');
            $table->date('start_date')->nullable()->comment('開始日');
            $table->date('end_date')->nullable()->comment('終了日');
            $table->timestamps();
            $table->softDeletes();
        });
    }

    public function down()
    {
        Schema::dropIfExists('courses');
    }
};

//　コーステーブル
return new class extends Migration
{
    public function up()
    {
        Schema::create('courses', function (Blueprint $table) {
            $table->id();
            $table->foreignId('lesson_id')->constrained();
            $table->foreignId('course_category_id')->constrained();
            $table->string('name', 50)->comment('コース名');
            $table->text('description')->comment('コース概要');
            $table->string('course_photo_path')->nullable()->comment('コース画像');
            $table->datetime('application_start_date')->nullable()->comment('申込開始日');
            $table->datetime('application_end_date')->nullable()->comment('申込終了日');
            $table->timestamps();
            $table->softDeletes();
        });
    }

    public function down()
    {
        Schema::dropIfExists('courses');
    }
};

例: まとめてかくとき

return new class extends Migration
{
    public function up()
    {
        Schema::create('course_categories', function (Blueprint $table) {
            $table->id();
            $table->foreignId('store_id')->constrained();
            $table->string('name', 50)->comment('コースカテゴリー名');
            $table->text('description')->comment('コース概要');
            $table->string('course_photo_path')->nullable()->comment('コース画像');
            $table->date('start_date')->nullable()->comment('開始日');
            $table->date('end_date')->nullable()->comment('終了日');
            $table->timestamps();
            $table->softDeletes();
        });

        Schema::create('courses', function (Blueprint $table) {
            $table->id();
            $table->foreignId('lesson_id')->constrained();
            $table->foreignId('course_category_id')->constrained();
            $table->string('name', 50)->comment('コース名');
            $table->text('description')->comment('コース概要');
            $table->string('course_photo_path')->nullable()->comment('コース画像');
            $table->datetime('application_start_date')->nullable()->comment('申込開始日');
            $table->datetime('application_end_date')->nullable()->comment('申込終了日');
            $table->timestamps();
            $table->softDeletes();
        });
    }

    public function down()
    {
        Schema::dropIfExists('courses');
        Schema::dropIfExists('course_categories');
    }
};

ただし、その際にはいくつかの注意点があります。

その注意点についてまとめました。

複数のテーブルを1つのMigrationにまとめる場合の注意点

  1. 関連テーブルの順序 upメソッドでは、依存関係のあるテーブルを先に作成する必要があります。例えば、coursesテーブルがcourse_categoriesテーブルに依存しているため、course_categoriesテーブルを先に作成する必要があります。今回の例では、その順序は正しいです。
  2. downメソッドの順序 downメソッドでは、逆順で削除しなければなりません。つまり、upで最後に作成したテーブル（courses）を最初に削除し、その後に依存元のcourse_categoriesを削除する必要があります。もしこれを間違えると、参照制約によってテーブルが削除できない場合があります。したがって、次のようにdownメソッドを修正する必要があります。phpコードをコピーするpublic function down() { Schema::dropIfExists('courses'); Schema::dropIfExists('course_categories'); }
  3. データベースの一貫性 複数のテーブルを1つのMigrationにまとめることで、関連するテーブルが一度に作成されるため、データベースの整合性が保たれます。ただし、テーブルの数が増えると、どのMigrationがどのテーブルを作成しているかを把握するのが難しくなる可能性があります。
  4. Migrationファイルの管理 たくさんのMigrationファイルが増えてきた場合、見つけづらくなるという課題がありますが、Migrationファイルの命名規則をしっかり守り、意味のある名前を付けることである程度管理が容易になります。例えば、create_courses_and_course_categories_tableのように命名することが推奨されます。

Migrationファイルをまとめるメリットとデメリット

メリット

  • 関連するテーブルを一度に作成でき、開発効率が向上。
  • 一貫性が保たれる。
  • 一度にまとめてテーブル作成、削除の処理ができる。

デメリット

  • 一つのMigrationファイルが大きくなり、可読性が低下する可能性がある。
  • 依存関係が複雑になると、downメソッドの実装にミスが生じやすくなる。
  • 後々の変更がしづらくなる可能性がある。

ベストプラクティス

  1. 依存関係の順序を守る
    依存関係のあるテーブルは、必ずupでは先に作成し、downでは後に削除するようにする。
  2. 関連テーブルをグループ化する
    関連するテーブル（例：coursesやcourse_categoriesなど）をまとめるのは良いですが、無理に1つのMigrationに全てのテーブルを詰め込むのではなく、適度にグループ化することが大切です。
  3. Migrationの命名規則に従う
    Migrationファイルの名前に、どのテーブルを作成しているか分かるような命名をすることで、後々の管理が楽になります。

結論

複数のテーブルを1つのMigrationにまとめることは可能で、

正しい順序で処理を行えば問題ありません。

特に関連するテーブル（例：コースやカテゴリーなど）がある場合は、

それらを1つのMigrationでまとめることが合理的です。

しかし、downメソッドの順序には十分注意し、依存関係を破らないようにしてください。

また、Migrationファイルの命名規則やファイル管理に気をつけることで、

将来的なメンテナンス性も向上します。

タイトルとURLをコピーしました