Laravel 4.2 スキーマビルダー

イントロダクション

LaravelのSchemaクラスは、データテーブルに不可知論的なテーブル操作方法を提供しています。これはLaravelがサポートしている全てのデータベースで上手く動作し、共通のAPIを持っています。

テーブル作成／削除

テーブルを作成するには、Schema::createメソッドを使用します。

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

createメソッドの最初の引数はテーブル名で、２つ目は無名関数です。新しいテーブルを定義するためのBlueprintオブジェクトを取ります。

存在しているテーブルの名前を変更するにはrenameメソッドを使用してください。

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

スキーマ操作のコネクションを指定するには、Schema::connectionメソッドを最初に使用します。

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

テーブルをドロップするためには、Schema::dropメソッドを使用します。

Schema::drop('users');

Schema::dropIfExists('users');

カラム追加

既に存在するテーブルを更新するには、Schema::tableメソッドを使用します。

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

テーブルビルダーは構築に使用する様々なカラムのタイプで構成されています。

MySQLでafterメソッドを使用する

MySQLデータベースをお使いでしたら、afterメソッドでカラムの順番を指定することができます。

$table->string('name')->after('email');

カラム名変更

カラム名を変更するためにはrenameColumnメソッドをスキーマビルダーで使用してください。カラム名を変更する前に、composer.jsonファイルでdoctrine/dbalを依存パッケージとして追加済みであることを確認してください。

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

注目： enumカラムタイプのリネームはサポートしていません。

カラム削除

カラムをドロップするには、スキーマビルダーのdropColumnメソッドを使用します。カラムをドロップする前に、composer.jsonファイルへdoctrine/dbal依存パッケージを確実に追加してください。

データベーステーブルからカラムをドロップする

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

データベーステーブルから複数のカラムをドロップする

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

存在チェック

テーブルの存在をチェックする

hasTableやhasColumnを使用し簡単にテーブル、カラムが存在するかチェックできます。

if (Schema::hasTable('users'))
{
    //
}

カラムの存在をチェックする

if (Schema::hasColumn('users', 'email'))
{
    //
}

インデックス追加

スキーマビルダーは様々なインデックスタイプをサポートしています。追加方法は２つあります。カラムの定義と同時に記述する方法と、後から追加する方法です。

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

もしくは、別の行でインデックスを追加することを選べます。指定可能なインデックスタイプの一覧です。

外部キー

Laravelはテーブル対する、外部キー束縛の追加も提供しています。

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

この例では、user_idカラムがusersテーブルのidカラムを参照していることを宣言しています。外部キーカラムを最初に作成するのを忘れないでください。

さらに束縛に対して「デリート時(on delete)」と「更新時(on update)」に対する処理をオプションとして指定できます。

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

外部キーを削除するには、dropForeignメソッドを使用します。他のインデックスで使用されるものと似た命名規則が外部キーにも使用されています。

$table->dropForeign('posts_user_id_foreign');

注目：自動増分する整数として参照される外部キーを作成する場合、外部キーの項目作成時はいつでもunsignedを付けるのをお忘れなく。

インデックス削除

インデックスを削除する場合、インデックスの名前を指定します。Laravelはデフォルトで意味が通る名前をインデックスに付けます。シンプルにテーブル名、カラム名、インデックスタイプをつなげたものです。いくつか例をご覧ください。

タイムスタンプとソフトデリートフィールド削除

timestamps、nullableTimestamps、softDeletesの絡むタイプを削除するためには、以下のメソッドが使用できます。

ストレージエンジン

テーブルにストレージエンジンを設定するには、engineプロパティーをスキーマビルダーにセットしてください。

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

    $table->string('email');
});