バージョン: master

データベース: 移行 (Database: Migrations)

Introduction
移行の生成
- 移行を潰す
移行構造
移行の実行
- 移行のロールバック
Tables
Columns
Indexes
Events

導入 (Introduction)

移行はデータベースのバージョン管理のようなもので、チームがアプリケーションのデータベーススキーマ定義を定義して共有できるようにします。ソース管理から変更を取り込んだ後、ローカルデータベーススキーマに列を手動で追加するようにチームメイトに指示しなければならなかった場合は、データベースの移行によって解決される問題に直面したことがあるでしょう。

Laravel Schema facade は、Laravel でサポートされているすべてのデータベースシステムにわたってテーブルを作成および操作するためのデータベースに依存しないサポートを提供します。通常、移行ではこのファサードを使用してデータベースのテーブルと列を作成および変更します。

移行の生成 (Generating Migrations)

make:migration Artisan コマンドを使用してデータベース移行を生成できます。新しい移行は、database/migrations ディレクトリに配置されます。各移行ファイル名には、Laravel が移行の順序を決定できるようにするタイムスタンプが含まれています。

php artisan make:migration create_flights_table

Laravel は移行の名前を使用して、テーブルの名前と、移行によって新しいテーブルが作成されるかどうかを推測しようとします。 Laravel が移行名からテーブル名を決定できる場合、Laravel は生成された移行ファイルに指定されたテーブルを事前に入力します。それ以外の場合は、移行ファイルにテーブルを手動で指定するだけです。

生成された移行のカスタムパスを指定したい場合は、make:migration コマンドを実行するときに --path オプションを使用できます。指定されたパスは、アプリケーションのベースパスに対する相対パスである必要があります。

移行スタブは、スタブ発行を使用してカスタマイズできます。

移行を潰す

アプリケーションを構築すると、時間の経過とともにさらに多くの移行が蓄積される可能性があります。これにより、数百もの移行が行われる可能性があり、database/migrations ディレクトリが肥大化する可能性があります。必要に応じて、移行を単一の SQL ファイルに「圧縮」することもできます。まず、schema:dump コマンドを実行します。

php artisan schema:dump

# Dump the current database schema and prune all existing migrations...
php artisan schema:dump --prune

このコマンドを実行すると、Laravel はアプリケーションの database/schema ディレクトリに「スキーマ」ファイルを書き込みます。スキーマファイルの名前はデータベース接続に対応します。ここで、他の移行が実行されていないときにデータベースを移行しようとすると、Laravel はまず、使用しているデータベース接続のスキーマファイル内の SQL ステートメントを実行します。スキーマファイルのSQLステートメントを実行した後、Laravelはスキーマダンプの一部ではなかった残りの移行を実行します。

アプリケーションのテストでローカル開発中に通常使用するデータベース接続とは異なるデータベース接続を使用する場合は、テストでデータベースを構築できるように、そのデータベース接続を使用してスキーマファイルをダンプしていることを確認する必要があります。ローカル開発中に通常使用するデータベース接続をダンプした後でこれを実行するとよいでしょう。

php artisan schema:dump
php artisan schema:dump --database=testing --prune

チームの他の新しい開発者がアプリケーションの初期データベース構造を迅速に作成できるように、データベーススキーマファイルをソース管理にコミットする必要があります。

移行スカッシングは、MariaDB、MySQL、PostgreSQL、および SQLite データベースでのみ利用可能であり、データベースのコマンドラインクライアントを利用します。

移行構造 (Migration Structure)

移行クラスには、up と down の 2 つのメソッドが含まれています。 up メソッドは、新しいテーブル、列、またはインデックスをデータベースに追加するために使用されますが、down メソッドは、up メソッドによって実行された操作を元に戻す必要があります。

これらの両方のメソッド内で、Laravel スキーマビルダを使用して、テーブルを表現的に作成および変更できます。 Schema ビルダ、ドキュメントを確認してくださいで使用できるすべてのメソッドについて学習するには。たとえば、次の移行では flights テーブルが作成されます。

<?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('flights', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->string('airline');
            $table->timestamps();
        });
    }

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

移行接続の設定

移行がアプリケーションのデフォルトのデータベース接続以外のデータベース接続と対話する場合は、移行の $connection プロパティを設定する必要があります。

/**
 * The database connection that should be used by the migration.
 *
 * @var string
 */
protected $connection = 'pgsql';

/**
 * Run the migrations.
 */
public function up(): void
{
    // ...
}

移行のスキップ

場合によっては、移行は、まだアクティブではなく、まだ実行したくない機能をサポートすることを目的としている場合があります。この場合、移行時に shouldRun メソッドを定義できます。 shouldRun メソッドが false を返した場合、移行はスキップされます。

use App\Models\Flight;
use Laravel\Pennant\Feature;

/**
 * Determine if this migration should run.
 */
public function shouldRun(): bool
{
    return Feature::active(Flight::class);
}

移行の実行 (Running Migrations)

未処理の移行をすべて実行するには、migrate Artisan コマンドを実行します。

php artisan migrate

どの移行がすでに実行され、どの移行がまだ保留中であるかを確認したい場合は、migrate:status Artisan コマンドを使用できます。

php artisan migrate:status

migrate コマンドに --step オプションを指定すると、コマンドは各移行を独自のバッチとして実行し、後から migrate:rollback コマンドを使用して個々の移行をロールバックできます。

php artisan migrate --step

移行によって実行される SQL ステートメントを実際に実行せずに確認したい場合は、--pretend フラグを migrate コマンドに指定できます。

php artisan migrate --pretend

移行実行の分離

アプリケーションを複数のサーバーにデプロイし、デプロイメントプロセスの一環として移行を実行している場合、2 つのサーバーが同時にデータベースを移行しようとすることは望ましくありません。これを回避するには、migrate コマンドを呼び出すときに isolated オプションを使用できます。

isolated オプションが指定されている場合、Laravel は移行の実行を試行する前に、アプリケーションのキャッシュドライバを使用してアトミックロックを取得します。ロックが保持されている間に migrate コマンドを実行しようとする他の試みはすべて実行されません。ただし、コマンドは引き続き正常終了ステータスコードで終了します。

php artisan migrate --isolated

この機能を利用するには、アプリケーションが memcached、redis、dynamodb、database、file、または array キャッシュドライバをアプリケーションのデフォルトキャッシュドライバとして使用している必要があります。さらに、すべてのサーバーが同じ中央キャッシュサーバーと通信している必要があります。

本番環境での強制的な移行の実行

一部の移行操作は破壊的なものであり、データが失われる可能性があります。運用データベースに対してこれらのコマンドを実行しないようにするために、コマンドを実行する前に確認を求めるメッセージが表示されます。プロンプトを表示せずにコマンドを強制的に実行するには、--force フラグを使用します。

php artisan migrate --force

移行のロールバック

最新の移行操作をロールバックするには、rollback Artisan コマンドを使用できます。このコマンドは、移行の最後の「バッチ」をロールバックします。これには複数の移行ファイルが含まれる場合があります。

php artisan migrate:rollback

step オプションを rollback コマンドに指定すると、限られた数の移行をロールバックできます。たとえば、次のコマンドは最後の 5 つの移行をロールバックします。

php artisan migrate:rollback --step=5

rollback コマンドに batch オプションを指定すると、移行の特定の「バッチ」をロールバックできます。batch オプションは、アプリケーションの migrations データベーステーブル内のバッチ値に対応します。たとえば、次のコマンドはバッチ 3 のすべての移行をロールバックします。

php artisan migrate:rollback --batch=3

移行によって実行される SQL ステートメントを実際に実行せずに確認したい場合は、--pretend フラグを migrate:rollback コマンドに指定できます。

php artisan migrate:rollback --pretend

migrate:reset コマンドは、アプリケーションのすべての移行をロールバックします。

php artisan migrate:reset

単一のコマンドを使用したロールバックと移行

migrate:refresh コマンドは、すべての移行をロールバックしてから、migrate コマンドを実行します。このコマンドはデータベース全体を効果的に再作成します。

php artisan migrate:refresh

# Refresh the database and run all database seeds...
php artisan migrate:refresh --seed

refresh コマンドに step オプションを指定すると、限られた数の移行をロールバックして再移行できます。たとえば、次のコマンドは、最後の 5 つの移行をロールバックして再移行します。

php artisan migrate:refresh --step=5

すべてのテーブルを削除して移行する

migrate:fresh コマンドは、データベースからすべてのテーブルを削除してから、migrate コマンドを実行します。

php artisan migrate:fresh

php artisan migrate:fresh --seed

デフォルトでは、migrate:fresh コマンドはデフォルトのデータベース接続からテーブルのみを削除します。ただし、--database オプションを使用して、移行するデータベース接続を指定できます。データベース接続名は、アプリケーションの database 設定ファイルで定義された接続に対応する必要があります。

php artisan migrate:fresh --database=admin

migrate:fresh コマンドは、プレフィックスに関係なく、すべてのデータベーステーブルを削除します。他のアプリケーションと共有されるデータベース上で開発する場合、このコマンドは注意して使用する必要があります。

テーブル (Tables)

テーブルの作成

新しいデータベーステーブルを作成するには、Schema ファサードで create メソッドを使用します。 create メソッドは 2 つの引数を受け入れます。1 つ目はテーブルの名前で、2 つ目は新しいテーブルの定義に使用できる Blueprint オブジェクトを受け取るクロージャです。

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

Schema::create('users', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->string('email');
    $table->timestamps();
});

テーブルを作成するときは、スキーマビルダの列メソッドのいずれかを使用してテーブルの列を定義できます。

テーブル/カラムの存在の確認

hasTable、hasColumn、および hasIndex メソッドを使用して、テーブル、列、またはインデックスの存在を確認できます。

if (Schema::hasTable('users')) {
    // The "users" table exists...
}

if (Schema::hasColumn('users', 'email')) {
    // The "users" table exists and has an "email" column...
}

if (Schema::hasIndex('users', ['email'], 'unique')) {
    // The "users" table exists and has a unique index on the "email" column...
}

データベース接続とテーブルのオプション

アプリケーションのデフォルト接続ではないデータベース接続でスキーマ操作を実行する場合は、connection メソッドを使用します。

Schema::connection('sqlite')->create('users', function (Blueprint $table) {
    $table->id();
});

さらに、他のいくつかのプロパティとメソッドを使用して、テーブル作成の他の側面を定義することもできます。 MariaDB または MySQL を使用する場合、engine プロパティを使用してテーブルのストレージエンジンを指定できます。

Schema::create('users', function (Blueprint $table) {
    $table->engine('InnoDB');

    // ...
});

MariaDB または MySQL を使用する場合、charset プロパティと collation プロパティを使用して、作成されたテーブルの文字セットと照合順序を指定できます。

Schema::create('users', function (Blueprint $table) {
    $table->charset('utf8mb4');
    $table->collation('utf8mb4_unicode_ci');

    // ...
});

temporary メソッドを使用して、テーブルを「一時的」にする必要があることを示すことができます。一時テーブルは現在の接続のデータベースセッションにのみ表示され、接続が閉じられると自動的に削除されます。

Schema::create('calculations', function (Blueprint $table) {
    $table->temporary();

    // ...
});

データベーステーブルに「コメント」を追加したい場合は、テーブルインスタンスで comment メソッドを呼び出します。テーブルコメントは現在、MariaDB、MySQL、および PostgreSQL でのみサポートされています。

Schema::create('calculations', function (Blueprint $table) {
    $table->comment('Business calculations');

    // ...
});

テーブルの更新

Schema ファサードの table メソッドを使用して、既存のテーブルを更新できます。 create メソッドと同様に、table メソッドは 2 つの引数を受け入れます。テーブルの名前と、テーブルに列またはインデックスを追加するために使用できる Blueprint インスタンスを受け取るクロージャです。

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

Schema::table('users', function (Blueprint $table) {
    $table->integer('votes');
});

テーブルの名前変更/削除

既存のデータベーステーブルの名前を変更するには、rename メソッドを使用します。

use Illuminate\Support\Facades\Schema;

Schema::rename($from, $to);

既存のテーブルを削除するには、drop メソッドまたは dropIfExists メソッドを使用できます。

Schema::drop('users');

Schema::dropIfExists('users');

外部キーを使用したテーブルの名前変更

テーブルの名前を変更する前に、Laravel に規則に基づいた名前を割り当てるのではなく、テーブルの外部キー制約に明示的な名前が移行ファイルに含まれていることを確認する必要があります。それ以外の場合、外部キー制約名は古いテーブル名を参照します。

コラム (Columns)

列の作成

Schema ファサードの table メソッドを使用して、既存のテーブルを更新できます。 create メソッドと同様に、table メソッドは 2 つの引数を受け入れます。テーブルの名前と、テーブルに列を追加するために使用できる Illuminate\Database\Schema\Blueprint インスタンスを受け取るクロージャです。

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

Schema::table('users', function (Blueprint $table) {
    $table->integer('votes');
});

利用可能な列のタイプ

スキーマビルダブループリントは、データベーステーブルに追加できるさまざまな種類の列に対応するさまざまなメソッドを提供します。使用可能な各メソッドを次の表に示します。

`bigIncrements()`

bigIncrements メソッドは、自動インクリメントする UNSIGNED BIGINT (主キー) と同等の列を作成します。

$table->bigIncrements('id');

`bigInteger()`

bigInteger メソッドは、BIGINT と同等の列を作成します。

$table->bigInteger('votes');

`binary()`

binary メソッドは、BLOB と同等の列を作成します。

$table->binary('photo');

MySQL、MariaDB、または SQL Server を利用する場合、length および fixed 引数を渡して、VARBINARY または BINARY と同等の列を作成できます。

$table->binary('data', length: 16); // VARBINARY(16)

$table->binary('data', length: 16, fixed: true); // BINARY(16)

`boolean()`

boolean メソッドは、BOOLEAN と同等の列を作成します。

$table->boolean('confirmed');

`char()`

char メソッドは、指定された長さの CHAR と同等の列を作成します。

$table->char('name', length: 100);

`dateTimeTz()`

dateTimeTz メソッドは、オプションの小数秒精度を持つ DATETIME (タイムゾーン付き) と同等の列を作成します。

$table->dateTimeTz('created_at', precision: 0);

`dateTime()`

dateTime メソッドは、オプションの小数秒精度を使用して、DATETIME と同等の列を作成します。

$table->dateTime('created_at', precision: 0);

`date()`

date メソッドは、DATE と同等の列を作成します。

$table->date('created_at');

`decimal()`

decimal メソッドは、指定された精度 (合計桁数) と位取り (10 進数の桁数) を持つ DECIMAL と同等の列を作成します。

$table->decimal('amount', total: 8, places: 2);

`double()`

double メソッドは、DOUBLE と同等の列を作成します。

$table->double('amount');

`enum()`

enum メソッドは、指定された有効な値を使用して ENUM と同等の列を作成します。

$table->enum('difficulty', ['easy', 'hard']);

もちろん、許可される値の配列を手動で定義する代わりに、Enum::cases() メソッドを使用することもできます。

use App\Enums\Difficulty;

$table->enum('difficulty', Difficulty::cases());

`float()`

float メソッドは、指定された精度で FLOAT と同等の列を作成します。

$table->float('amount', precision: 53);

`foreignId()`

foreignId メソッドは、UNSIGNED BIGINT と同等の列を作成します。

$table->foreignId('user_id');

`foreignIdFor()`

foreignIdFor メソッドは、指定されたモデルクラスに {column}_id と同等の列を追加します。列のタイプは、モデルのキーのタイプに応じて、UNSIGNED BIGINT、CHAR(36)、または CHAR(26) になります。

$table->foreignIdFor(User::class);

`foreignUlid()`

foreignUlid メソッドは、ULID と同等の列を作成します。

$table->foreignUlid('user_id');

`foreignUuid()`

foreignUuid メソッドは、UUID と同等の列を作成します。

$table->foreignUuid('user_id');

`geography()`

geography メソッドは、指定された空間タイプと SRID (空間参照システム識別子) を使用して、GEOGRAPHY と同等の列を作成します。

$table->geography('coordinates', subtype: 'point', srid: 4326);

空間タイプのサポートは、データベースドライバによって異なります。データベースのドキュメントを参照してください。アプリケーションが PostgreSQL データベースを利用している場合は、geography メソッドを使用する前に、PostGIS 拡張機能をインストールする必要があります。

`geometry()`

geometry メソッドは、指定された空間タイプと SRID (空間参照システム識別子) を使用して、GEOMETRY と同等の列を作成します。

$table->geometry('positions', subtype: 'point', srid: 0);

空間タイプのサポートは、データベースドライバによって異なります。データベースのドキュメントを参照してください。アプリケーションが PostgreSQL データベースを利用している場合は、geometry メソッドを使用する前に、PostGIS 拡張機能をインストールする必要があります。

`id()`

id メソッドは、bigIncrements メソッドのエイリアスです。デフォルトでは、このメソッドは id 列を作成します。ただし、列に別の名前を割り当てたい場合は、列名を渡すことができます。

$table->id();

`increments()`

increments メソッドは、自動インクリメントする UNSIGNED INTEGER と同等の列を主キーとして作成します。

$table->increments('id');

`integer()`

integer メソッドは、INTEGER と同等の列を作成します。

$table->integer('votes');

`ipAddress()`

ipAddress メソッドは、VARCHAR と同等の列を作成します。

$table->ipAddress('visitor');

PostgreSQLを使用する場合、INET列が作成されます。

`json()`

json メソッドは、JSON と同等の列を作成します。

$table->json('options');

SQLiteを使用する場合、TEXT列が作成されます。

`jsonb()`

jsonb メソッドは、JSONB と同等の列を作成します。

$table->jsonb('options');

SQLiteを使用する場合、TEXT列が作成されます。

`longText()`

longText メソッドは、LONGTEXT と同等の列を作成します。

$table->longText('description');

MySQL または MariaDB を利用する場合、LONGBLOB と同等の列を作成するために、binary 文字セットを列に適用できます。

$table->longText('data')->charset('binary'); // LONGBLOB

`macAddress()`

macAddress メソッドは、MAC アドレスを保持するための列を作成します。 PostgreSQL などの一部のデータベースシステムには、このタイプのデータ専用の列タイプがあります。他のデータベースシステムでは、文字列と同等の列が使用されます。

$table->macAddress('device');

`mediumIncrements()`

mediumIncrements メソッドは、自動インクリメントする UNSIGNED MEDIUMINT と同等の列を主キーとして作成します。

$table->mediumIncrements('id');

`mediumInteger()`

mediumInteger メソッドは、MEDIUMINT と同等の列を作成します。

$table->mediumInteger('votes');

`mediumText()`

mediumText メソッドは、MEDIUMTEXT と同等の列を作成します。

$table->mediumText('description');

MySQL または MariaDB を利用する場合、MEDIUMBLOB と同等の列を作成するために、binary 文字セットを列に適用できます。

$table->mediumText('data')->charset('binary'); // MEDIUMBLOB

`morphs()`

morphs メソッドは、{column}_id に相当する列と {column}_type VARCHAR に相当する列を追加する便利なメソッドです。 {column}_id の列タイプは、モデルのキータイプに応じて、UNSIGNED BIGINT、CHAR(36)、または CHAR(26) になります。

このメソッドは、多態性 Eloquent リレーションに必要な列を定義するときに使用することを目的としています。次の例では、taggable_id 列と taggable_type 列が作成されます。

$table->morphs('taggable');

`nullableMorphs()`

このメソッドは morphs メソッドに似ています。ただし、作成される列は「NULL 可能」になります。

$table->nullableMorphs('taggable');

`nullableUlidMorphs()`

このメソッドは ulidMorphs メソッドに似ています。ただし、作成される列は「NULL 可能」になります。

$table->nullableUlidMorphs('taggable');

`nullableUuidMorphs()`

このメソッドは uuidMorphs メソッドに似ています。ただし、作成される列は「NULL 可能」になります。

$table->nullableUuidMorphs('taggable');

`rememberToken()`

rememberToken メソッドは、現在の「remember me」認証トークンを格納するための、null 許容の VARCHAR(100) と同等の列を作成します。

$table->rememberToken();

`set()`

set メソッドは、指定された有効な値のリストを使用して、SET と同等の列を作成します。

$table->set('flavors', ['strawberry', 'vanilla']);

`smallIncrements()`

smallIncrements メソッドは、自動インクリメントする UNSIGNED SMALLINT と同等の列を主キーとして作成します。

$table->smallIncrements('id');

`smallInteger()`

smallInteger メソッドは、SMALLINT と同等の列を作成します。

$table->smallInteger('votes');

`softDeletesTz()`

softDeletesTz メソッドは、オプションの小数秒精度を持つ、NULL 許容の deleted_at TIMESTAMP (タイムゾーンあり) と同等の列を追加します。この列は、Eloquent の「論理的な削除」機能に必要な deleted_at タイムスタンプを保存することを目的としています。

$table->softDeletesTz('deleted_at', precision: 0);

`softDeletes()`

softDeletes メソッドは、オプションの小数秒精度を持つ、NULL 許容の deleted_at TIMESTAMP 同等の列を追加します。この列は、Eloquent の「論理的な削除」機能に必要な deleted_at タイムスタンプを保存することを目的としています。

$table->softDeletes('deleted_at', precision: 0);

`string()`

string メソッドは、指定された長さの VARCHAR と同等の列を作成します。

$table->string('name', length: 100);

`text()`

text メソッドは、TEXT と同等の列を作成します。

$table->text('description');

MySQL または MariaDB を利用する場合、BLOB と同等の列を作成するために、binary 文字セットを列に適用できます。

$table->text('data')->charset('binary'); // BLOB

`timeTz()`

timeTz メソッドは、オプションの小数秒精度を持つ TIME (タイムゾーン付き) と同等の列を作成します。

$table->timeTz('sunrise', precision: 0);

`time()`

time メソッドは、オプションの小数秒精度を使用して、TIME と同等の列を作成します。

$table->time('sunrise', precision: 0);

`timestampTz()`

timestampTz メソッドは、オプションの小数秒精度を持つ TIMESTAMP (タイムゾーン付き) と同等の列を作成します。

$table->timestampTz('added_at', precision: 0);

`timestamp()`

timestamp メソッドは、オプションの小数秒精度を使用して、TIMESTAMP と同等の列を作成します。

$table->timestamp('added_at', precision: 0);

`timestampsTz()`

timestampsTz メソッドは、オプションの小数秒精度を使用して、created_at および updated_at TIMESTAMP (タイムゾーン付き) と同等の列を作成します。

$table->timestampsTz(precision: 0);

`timestamps()`

timestamps メソッドは、オプションの小数秒精度を使用して、created_at および updated_at TIMESTAMP と同等の列を作成します。

$table->timestamps(precision: 0);

`tinyIncrements()`

tinyIncrements メソッドは、自動インクリメントする UNSIGNED TINYINT と同等の列を主キーとして作成します。

$table->tinyIncrements('id');

`tinyInteger()`

tinyInteger メソッドは、TINYINT と同等の列を作成します。

$table->tinyInteger('votes');

`tinyText()`

tinyText メソッドは、TINYTEXT と同等の列を作成します。

$table->tinyText('notes');

MySQL または MariaDB を利用する場合、TINYBLOB と同等の列を作成するために、binary 文字セットを列に適用できます。

$table->tinyText('data')->charset('binary'); // TINYBLOB

`unsignedBigInteger()`

unsignedBigInteger メソッドは、UNSIGNED BIGINT と同等の列を作成します。

$table->unsignedBigInteger('votes');

`unsignedInteger()`

unsignedInteger メソッドは、UNSIGNED INTEGER と同等の列を作成します。

$table->unsignedInteger('votes');

`unsignedMediumInteger()`

unsignedMediumInteger メソッドは、UNSIGNED MEDIUMINT と同等の列を作成します。

$table->unsignedMediumInteger('votes');

`unsignedSmallInteger()`

unsignedSmallInteger メソッドは、UNSIGNED SMALLINT と同等の列を作成します。

$table->unsignedSmallInteger('votes');

`unsignedTinyInteger()`

unsignedTinyInteger メソッドは、UNSIGNED TINYINT と同等の列を作成します。

$table->unsignedTinyInteger('votes');

`ulidMorphs()`

ulidMorphs メソッドは、{column}_id CHAR(26) に相当する列と、{column}_type VARCHAR に相当する列を追加する便利なメソッドです。

このメソッドは、ULID 識別子を使用する多態性 Eloquent リレーションに必要な列を定義するときに使用することを目的としています。次の例では、taggable_id 列と taggable_type 列が作成されます。

$table->ulidMorphs('taggable');

`uuidMorphs()`

uuidMorphs メソッドは、{column}_id CHAR(36) に相当する列と、{column}_type VARCHAR に相当する列を追加する便利なメソッドです。

このメソッドは、UUID 識別子を使用する多様なEloquent リレーションに必要な列を定義するときに使用することを目的としています。次の例では、taggable_id 列と taggable_type 列が作成されます。

$table->uuidMorphs('taggable');

`ulid()`

ulid メソッドは、ULID と同等の列を作成します。

$table->ulid('id');

`uuid()`

uuid メソッドは、UUID と同等の列を作成します。

$table->uuid('id');

`vector()`

vector メソッドは、vector と同等の列を作成します。

$table->vector('embedding', dimensions: 100);

PostgreSQL を利用する場合、vector 列を作成する前に、pgvector 拡張機能をロードする必要があります。

Schema::ensureVectorExtensionExists();

`year()`

year メソッドは、YEAR と同等の列を作成します。

$table->year('birth_year');

列修飾子

上記の列タイプに加えて、データベーステーブルに列を追加するときに使用できる列「修飾子」がいくつかあります。たとえば、列を「NULL 可能」にするには、nullable メソッドを使用します。

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

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

次の表には、使用可能な列修飾子がすべて含まれています。このリストには、インデックス修飾子は含まれていません。

修飾子	説明
`->after('column')`	列を別の列 (MariaDB / MySQL) の「後」に配置します。
`->autoIncrement()`	`INTEGER` 列を自動インクリメント (主キー) として設定します。
`->charset('utf8mb4')`	カラム（MariaDB / MySQL）の文字セットを指定します。
`->collation('utf8mb4_unicode_ci')`	列の照合順序を指定します。
`->comment('my comment')`	列にコメントを追加します (MariaDB / MySQL / PostgreSQL)。
`->default($value)`	列の「デフォルト」値を指定します。
`->first()`	テーブル (MariaDB / MySQL) の「最初」に列を配置します。
`->from($integer)`	自動インクリメントフィールドの開始値を設定します (MariaDB / MySQL / PostgreSQL)。
`->instant()`	インスタント操作 (MySQL) を使用して列を追加または変更します。
`->invisible()`	列を `SELECT *` クエリに対して「非表示」にします (MariaDB / MySQL)。
`->lock($mode)`	カラム操作のロックモードを指定します(MySQL)。
`->nullable($value = true)`	`NULL` 値を列に挿入できるようにします。
`->storedAs($expression)`	格納された生成列 (MariaDB / MySQL / PostgreSQL / SQLite) を作成します。
`->unsigned()`	`INTEGER` 列を `UNSIGNED` (MariaDB / MySQL) として設定します。
`->useCurrent()`	`TIMESTAMP` 列をデフォルト値として `CURRENT_TIMESTAMP` を使用するように設定します。
`->useCurrentOnUpdate()`	レコードの更新時に `CURRENT_TIMESTAMP` を使用するように `TIMESTAMP` 列を設定します (MariaDB / MySQL)。
`->virtualAs($expression)`	仮想生成列 (MariaDB / MySQL / SQLite) を作成します。
`->generatedAs($expression)`	シーケンスオプションを指定して ID 列を作成します (PostgreSQL)。
`->always()`	ID 列の入力に対するシーケンス値の優先順位を定義します (PostgreSQL)。

デフォルトの式

default 修飾子は、値または Illuminate\Database\Query\Expression インスタンスを受け入れます。 Expression インスタンスを使用すると、Laravel が値を引用符で囲むことがなくなり、データベース固有の関数を使用できるようになります。これが特に役立つ状況の 1 つは、JSON 列にデフォルト値を割り当てる必要がある場合です。

<?php

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

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::create('flights', function (Blueprint $table) {
            $table->id();
            $table->json('movies')->default(new Expression('(JSON_ARRAY())'));
            $table->timestamps();
        });
    }
};

デフォルトの式のサポートは、データベースドライバ、データベースバージョン、およびフィールドタイプによって異なります。データベースのドキュメントを参照してください。

列の順序

MariaDB または MySQL データベースを使用する場合、after メソッドを使用して、スキーマ内の既存の列の後に列を追加できます。

$table->after('password', function (Blueprint $table) {
    $table->string('address_line1');
    $table->string('address_line2');
    $table->string('city');
});

インスタント列操作

MySQL を使用する場合、instant 修飾子を列定義に連結して、MySQL の「インスタント」アルゴリズムを使用して列を追加または変更する必要があることを示すことができます。このアルゴリズムにより、テーブル全体を再構築せずに特定のスキーマ変更を実行できるため、テーブルサイズに関係なく、ほぼ瞬時に変更が行われます。

$table->string('name')->nullable()->instant();

インスタント列追加ではテーブルの末尾にのみ列を追加できるため、instant 修飾子を after または first 修飾子と組み合わせることはできません。さらに、このアルゴリズムはすべての列の種類や操作をサポートしているわけではありません。要求された操作に互換性がない場合、MySQL はエラーを発生させます。

どの操作が列の即時変更と互換性があるかを判断するには、MySQL のドキュメントを参照してください。

DDL ロック

MySQL を使用する場合、lock 修飾子を列、インデックス、または外部キー定義に連鎖させて、スキーマ操作中のテーブルのロックを制御できます。 MySQL はいくつかのロックモードをサポートしています。 none は同時読み取りと書き込みを許可します。 shared は同時読み取りを許可しますが書き込みをブロックします。 exclusive はすべての同時アクセスをブロックします。 default は MySQL に最適なモードを選択させます。

$table->string('name')->lock('none');

$table->index('email')->lock('shared');

要求されたロックモードが操作と互換性がない場合、MySQL はエラーを生成します。 lock 修飾子を instant 修飾子と組み合わせて、スキーマ変更をさらに最適化することができます。

$table->string('name')->instant()->lock('none');

列の変更

change メソッドを使用すると、既存の列のタイプと属性を変更できます。たとえば、string 列のサイズを増やしたい場合があります。 change メソッドの動作を確認するには、name 列のサイズを 25 から 50 に増やしてみましょう。これを実現するには、単に列の新しい状態を定義してから、change メソッドを呼び出します。

Schema::table('users', function (Blueprint $table) {
    $table->string('name', 50)->change();
});

列を変更するときは、列定義に保持したいすべての修飾子を明示的に含める必要があります。欠落している属性は削除されます。たとえば、unsigned、default、および comment 属性を保持するには、列を変更するときに各修飾子を明示的に呼び出す必要があります。

Schema::table('users', function (Blueprint $table) {
    $table->integer('votes')->unsigned()->default(1)->comment('my comment')->change();
});

change メソッドは列のインデックスを変更しません。したがって、列を変更するときにインデックス修飾子を使用してインデックスを明示的に追加または削除できます。

// Add an index...
$table->bigIncrements('id')->primary()->change();

// Drop an index...
$table->char('postal_code', 10)->unique(false)->change();

列名の変更

列の名前を変更するには、スキーマビルダが提供する renameColumn メソッドを使用できます。

Schema::table('users', function (Blueprint $table) {
    $table->renameColumn('from', 'to');
});

列の削除

列を削除するには、スキーマビルダで dropColumn メソッドを使用できます。

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

列名の配列を dropColumn メソッドに渡すことで、テーブルから複数の列を削除できます。

Schema::table('users', function (Blueprint $table) {
    $table->dropColumn(['votes', 'avatar', 'location']);
});

使用可能なコマンドエイリアス

Laravel は、一般的なタイプの列の削除に関連する便利なメソッドをいくつか提供しています。これらの各方法については、次の表で説明します。

指示	説明
`$table->dropMorphs('morphable');`	`morphable_id` 列と `morphable_type` 列を削除します。
`$table->dropRememberToken();`	`remember_token` 列を削除します。
`$table->dropSoftDeletes();`	`deleted_at` 列を削除します。
`$table->dropSoftDeletesTz();`	`dropSoftDeletes()` メソッドの別名。
`$table->dropTimestamps();`	`created_at` 列と `updated_at` 列を削除します。
`$table->dropTimestampsTz();`	`dropTimestamps()` メソッドの別名。

インデックス (Indexes)

インデックスの作成

Laravel スキーマビルダは、いくつかの種類のインデックスをサポートしています。次の例では、新しい email 列を作成し、その値が一意である必要があることを指定します。インデックスを作成するには、unique メソッドを列定義に連鎖させます。

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

Schema::table('users', function (Blueprint $table) {
    $table->string('email')->unique();
});

あるいは、列を定義した後にインデックスを作成することもできます。これを行うには、スキーマビルダブループリントで unique メソッドを呼び出す必要があります。このメソッドは、一意のインデックスを受け取る列の名前を受け入れます。

$table->unique('email');

列の配列をインデックスメソッドに渡して、複合 (または複合) インデックスを作成することもできます。

$table->index(['account_id', 'created_at']);

インデックスを作成するとき、Laravel はテーブル、列名、インデックスの種類に基づいてインデックス名を自動的に生成しますが、メソッドに 2 番目の引数を渡してインデックス名を自分で指定することもできます。

$table->unique('email', 'unique_email');

利用可能なインデックスの種類

Laravel のスキーマビルダブループリントクラスは、Laravel でサポートされる各タイプのインデックスを作成するためのメソッドを提供します。各インデックスメソッドは、オプションの 2 番目の引数を受け入れてインデックスの名前を指定します。省略した場合、名前はインデックスに使用されるテーブルと列の名前、およびインデックスタイプから派生します。使用可能な各インデックス方法については、次の表で説明します。

指示	説明
`$table->primary('id');`	主キーを追加します。
`$table->primary(['id', 'parent_id']);`	複合キーを追加します。
`$table->unique('email');`	一意のインデックスを追加します。
`$table->index('state');`	インデックスを追加します。
`$table->fullText('body');`	全文インデックスを追加します (MariaDB / MySQL / PostgreSQL)。
`$table->fullText('body')->language('english');`	指定した言語 (PostgreSQL) の全文インデックスを追加します。
`$table->spatialIndex('location');`	空間インデックスを追加します (SQLite を除く)。

オンラインインデックス作成

デフォルトでは、大きなテーブルにインデックスを作成するとテーブルがロックされ、インデックスの構築中に読み取りまたは書き込みがブロックされることがあります。 PostgreSQL または SQL Server を使用する場合、online メソッドをインデックス定義にチェーンして、テーブルをロックせずにインデックスを作成すると、インデックス作成中にアプリケーションがデータの読み取りと書き込みを継続できるようになります。

$table->string('email')->unique()->online();

PostgreSQL を使用する場合、これにより、インデックス作成ステートメントに CONCURRENTLY オプションが追加されます。 SQL Server を使用する場合、これにより WITH (online = on) オプションが追加されます。

インデックスの名前変更

インデックスの名前を変更するには、スキーマビルダブループリントによって提供される renameIndex メソッドを使用できます。このメソッドは、現在のインデックス名を最初の引数として受け入れ、目的の名前を 2 番目の引数として受け入れます。

$table->renameIndex('from', 'to')

インデックスの削除

インデックスを削除するには、インデックスの名前を指定する必要があります。デフォルトでは、Laravel はテーブル名、インデックス付き列の名前、インデックスタイプに基づいてインデックス名を自動的に割り当てます。以下にいくつかの例を示します。

指示	説明
`$table->dropPrimary('users_id_primary');`	「users」テーブルから主キーを削除します。
`$table->dropUnique('users_email_unique');`	「users」テーブルから一意のインデックスを削除します。
`$table->dropIndex('geo_state_index');`	「geo」テーブルから基本インデックスを削除します。
`$table->dropFullText('posts_body_fulltext');`	「posts」テーブルから全文インデックスを削除します。
`$table->dropSpatialIndex('geo_location_spatialindex');`	「geo」テーブルから空間インデックスを削除します (SQLite を除く)。

インデックスを削除するメソッドに列の配列を渡すと、テーブル名、列、インデックスタイプに基づいて従来のインデックス名が生成されます。

Schema::table('geo', function (Blueprint $table) {
    $table->dropIndex(['state']); // Drops index 'geo_state_index'
});

外部キー制約

Laravel は、データベースレベルで参照整合性を強制するために使用される外部キー制約の作成のサポートも提供します。たとえば、users テーブルの id 列を参照する posts テーブルの user_id 列を定義してみましょう。

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

Schema::table('posts', function (Blueprint $table) {
    $table->unsignedBigInteger('user_id');

    $table->foreign('user_id')->references('id')->on('users');
});

この構文はかなり冗長であるため、Laravel では、より良い開発者エクスペリエンスを提供するために、規則を使用する追加の簡潔なメソッドが提供されています。 foreignId メソッドを使用して列を作成する場合、上記の例は次のように書き換えることができます。

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained();
});

foreignId メソッドは UNSIGNED BIGINT と同等の列を作成しますが、constrained メソッドは規則を使用して参照されるテーブルと列を決定します。テーブル名が Laravel の規則と一致しない場合は、それを constrained メソッドに手動で指定できます。さらに、生成されたインデックスに割り当てる名前も指定できます。

Schema::table('posts', function (Blueprint $table) {
    $table->foreignId('user_id')->constrained(
        table: 'users', indexName: 'posts_user_id'
    );
});

制約の「削除時」プロパティと「更新時」プロパティに必要なアクションを指定することもできます。

$table->foreignId('user_id')
    ->constrained()
    ->onUpdate('cascade')
    ->onDelete('cascade');

これらのアクションには、代替の表現力豊かな構文も提供されています。

方法	説明
`$table->cascadeOnUpdate();`	更新はカスケードする必要があります。
`$table->restrictOnUpdate();`	更新は制限されるべきです。
`$table->nullOnUpdate();`	更新では外部キー値を null に設定する必要があります。
`$table->noActionOnUpdate();`	更新に対するアクションはありません。
`$table->cascadeOnDelete();`	削除はカスケードする必要があります。
`$table->restrictOnDelete();`	削除は制限する必要があります。
`$table->nullOnDelete();`	削除では、外部キーの値を null に設定する必要があります。
`$table->noActionOnDelete();`	子レコードが存在する場合は削除を防止します。

追加の列修飾子は、constrained メソッドの前に呼び出す必要があります。

$table->foreignId('user_id')
    ->nullable()
    ->constrained();

外部キーの削除

外部キーを削除するには、dropForeign メソッドを使用して、削除する外部キー制約の名前を引数として渡します。外部キー制約では、インデックスと同じ命名規則が使用されます。つまり、外部キー制約名は、制約内のテーブル名と列名に基づいて、その後に「_foreign」サフィックスが付加されます。

$table->dropForeign('posts_user_id_foreign');

あるいは、外部キーを保持する列名を含む配列を dropForeign メソッドに渡すこともできます。配列は、Laravel の制約命名規則を使用して外部キー制約名に変換されます。

$table->dropForeign(['user_id']);

外部キー制約の切り替え

次の方法を使用して、移行内で外部キー制約を有効または無効にすることができます。

Schema::enableForeignKeyConstraints();

Schema::disableForeignKeyConstraints();

Schema::withoutForeignKeyConstraints(function () {
    // Constraints disabled within this closure...
});

SQLite はデフォルトで外部キー制約を無効にします。 SQLite を使用する場合は、移行で SQLite を作成する前に、データベース構成で外部キーのサポートを有効にするを実行してください。

イベント (Events)

便宜上、各移行操作では event がディスパッチされます。次のイベントはすべて、基本 Illuminate\Database\Events\MigrationEvent クラスを拡張します。

クラス	説明
`Illuminate\Database\Events\MigrationsStarted`	移行のバッチが実行されようとしています。
`Illuminate\Database\Events\MigrationsEnded`	移行のバッチの実行が終了しました。
`Illuminate\Database\Events\MigrationStarted`	単一の移行が実行されようとしています。
`Illuminate\Database\Events\MigrationEnded`	1 つの移行の実行が終了しました。
`Illuminate\Database\Events\NoPendingMigrations`	移行コマンドで保留中の移行が見つかりませんでした。
`Illuminate\Database\Events\SchemaDumped`	データベーススキーマダンプが完了しました。
`Illuminate\Database\Events\SchemaLoaded`	既存のデータベーススキーマダンプがロードされました。

導入 (Introduction)​

移行の生成 (Generating Migrations)​

移行を潰す​

移行構造 (Migration Structure)​

移行接続の設定​

移行のスキップ​

移行の実行 (Running Migrations)​

移行実行の分離​

本番環境での強制的な移行の実行​

移行のロールバック​

単一のコマンドを使用したロールバックと移行​

すべてのテーブルを削除して移行する​

テーブル (Tables)​

テーブルの作成​

テーブル/カラムの存在の確認​

データベース接続とテーブルのオプション​

テーブルの更新​

テーブルの名前変更/削除​

外部キーを使用したテーブルの名前変更​

コラム (Columns)​

列の作成​

利用可能な列のタイプ​

ブール型​

文字列とテキスト型​

数値型​

日付と時刻のタイプ​

バイナリ型​

オブジェクトと Json タイプ​

UUID と ULID のタイプ​

空間タイプ​

関係の種類​

専門分野の種類​

bigIncrements()​

bigInteger()​

binary()​

boolean()​

char()​

dateTimeTz()​

dateTime()​

date()​

decimal()​

double()​

enum()​

float()​

foreignId()​

foreignIdFor()​

foreignUlid()​

foreignUuid()​

geography()​

geometry()​

id()​

increments()​

integer()​

ipAddress()​

json()​

jsonb()​

longText()​

macAddress()​

mediumIncrements()​

mediumInteger()​

mediumText()​

morphs()​

nullableMorphs()​

nullableUlidMorphs()​

nullableUuidMorphs()​

rememberToken()​

set()​

smallIncrements()​

smallInteger()​

softDeletesTz()​

softDeletes()​

string()​

text()​

timeTz()​

time()​

timestampTz()​

timestamp()​

timestampsTz()​

timestamps()​

tinyIncrements()​

導入 (Introduction)

移行の生成 (Generating Migrations)

移行を潰す

移行構造 (Migration Structure)

移行接続の設定

移行のスキップ

移行の実行 (Running Migrations)

移行実行の分離

本番環境での強制的な移行の実行

移行のロールバック

単一のコマンドを使用したロールバックと移行

すべてのテーブルを削除して移行する

テーブル (Tables)

テーブルの作成

テーブル/カラムの存在の確認

データベース接続とテーブルのオプション

テーブルの更新

テーブルの名前変更/削除

外部キーを使用したテーブルの名前変更

コラム (Columns)

列の作成

利用可能な列のタイプ

ブール型

文字列とテキスト型

数値型

日付と時刻のタイプ

バイナリ型

オブジェクトと Json タイプ

UUID と ULID のタイプ

空間タイプ

関係の種類

専門分野の種類

`bigIncrements()`

`bigInteger()`

`binary()`

`boolean()`

`char()`

`dateTimeTz()`

`dateTime()`

`date()`

`decimal()`

`double()`

`enum()`

`float()`

`foreignId()`

`foreignIdFor()`

`foreignUlid()`

`foreignUuid()`

`geography()`

`geometry()`

`id()`

`increments()`

`integer()`

`ipAddress()`

`json()`

`jsonb()`

`longText()`

`macAddress()`

`mediumIncrements()`

`mediumInteger()`

`mediumText()`

`morphs()`

`nullableMorphs()`

`nullableUlidMorphs()`

`nullableUuidMorphs()`

`rememberToken()`

`set()`

`smallIncrements()`

`smallInteger()`

`softDeletesTz()`

`softDeletes()`

`string()`

`text()`

`timeTz()`

`time()`

`timestampTz()`

`timestamp()`

`timestampsTz()`

`timestamps()`

`tinyIncrements()`