laravelのmigrationに関して

投稿日：2019年7月14日更新日：2019年10月12日

DBのカラムの保守などをする場合のmigrationに関して。

ポツポツ使っていたのですが、しっかりまとめてなかったのでここでまとめて見ようかと思います。

Contents

1 カラム定義
2 実際の実行
3 既存DBからmigrationファイル

カラム定義

php aritisan make:migration create_jobs_table

1	php aritisan make:migration create_jobs_table

./database/migrationsの下にyyyy_MM_dd_hhmmss_create_jobs_table.phpが作成されます。

ここに下記の用にカラム定義をします。

<?php

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

class CreateJobsTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('jobs', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('queue')->index();
            $table->longText('payload');
            $table->unsignedTinyInteger('attempts');
            $table->unsignedInteger('reserved_at')->nullable();
            $table->unsignedInteger('available_at');
            $table->unsignedInteger('created_at');
        });
    }

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

<?php

use Illuminate\Support\Facades\Schema;

use Illuminate\Database\Schema\Blueprint;

use Illuminate\Database\Migrations\Migration;

class CreateJobsTable extends Migration

{

/**

* Run the migrations.

* @return void

public function up()

{

Schema::create('jobs', function (Blueprint $table) {

$table->bigIncrements('id');

$table->string('queue')->index();

$table->longText('payload');

$table->unsignedTinyInteger('attempts');

$table->unsignedInteger('reserved_at')->nullable();

$table->unsignedInteger('available_at');

$table->unsignedInteger('created_at');

});

}

/**

* Reverse the migrations.

* @return void

public function down()

{

Schema::dropIfExists('jobs');

}

実際の実行

php artisan migrate

1	php artisan migrate

このコマンドで実際にテーブルが作られます。

実際にテーブルが作られており、またmigrationsと言うテーブルにmigrationの記録が作られます。

一回実行すると基本的にはもう終了しています。

もしやり直したい場合は

php artisan make:rollback --step=1

1	php artisan make:rollback --step=1

で、戻します。–step=1をつけないと全migration処理がrollbackされます。(この時downと言うメソッドに定義しておかないとうまく動きません。downは通常はupの逆になります。)

もっと原始的な方法としてはmigrationsと言うテーブルで戻したい処理のレコードを物理的に消すと言う方法もあります。こうすると記録が消えますので、migrationsが最初から実行されます。

既存DBからmigrationファイル

ちなみに既存DBからmigrationファイルを作ることもできます。

https://github.com/Xethron/migrations-generator

composer require --dev "xethron/migrations-generator"
php artisan migrate:generate

1 2	composer require --dev "xethron/migrations-generator" php artisan migrate:generate

これだけで一気に既存 DBからのmigrationファイルが作られます。(レガシー系のプロジェクトに良さそうです。)