【Laravel】マイグレーションファイルの作成方法

こんにちは！CODE CLUB965のKです！

今回は、Laravelでマイグレーションファイルを作成する方法を書こうと思います。

マイグレーションファイルとは？

簡単に言うと、DB(データベース)の定義をするファイルです。

このファイルでテーブルを作成することができ、ファイル内でテーブルが持つカラムを定義します。

作成手順

作成手順は特に難しくはありません。

artisanコマンドを使用してマイグレーションファイルを作成します。

$ php artisan make:migration マイグレーションファイル名 --create=テーブル名(複数形)

マイグレーションファイルの名前は、分かりやすい任意のファイル名でOKです。

また、テーブル名は複数形で書きます。
ユーザー情報のテーブルを作成したければ、「--create=users」のように書きます。

上記のコマンドを叩くことで、プロジェクトのディレクトリ内の「database/migrations」直下にファイルが作成されます。
「2021_06_23_233251_ファイル名.php」のようなファイルが作成されます。

マイグレーションファイルの記述

マイグレーションファイルを作成したら、ファイル内にテーブルのカラムを定義します。

先程の Users テーブルのマイグレーションファイルを作成しようとした場合

$ php artisan make:migration create_users_table --create=users

と叩くと、マイグレーションファイルが作成されます。

ファイルの中身は以下のような感じで作成されます。

<?php

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

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->bigIncrements('id');
            // ここに必要なカラムを記述する
            $table->timestamps();
        });
    }

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

「up()」の中にテーブルで必要なカラムを記述することで定義することができます。

「down()」については、マイグレーションを取り消したい時に使うもので特にいじる必要はありません。

あとは、マイグレーションを実行するだけです。
以下に2パターンの実行コマンドを載せておきます。

// マイグレーションの実行
$ php artisan migrate

// 全てのテーブルを削除してからマイグレーションし直す
$ php artisan migrate:fresh

これでDBにテーブルを定義することができます。

最後に

今回はマイグレーションファイルの作成方法について解説しました。

マイグレーションの取り消し方法については次回の記事で詳しく説明したいと思います。

それでは、また！

Follow me!