Laravel 4.2 スキーマビルダー

イントロダクションIntroduction

LaravelのSchemaクラスは、データテーブルに不可知論的なテーブル操作方法を提供しています。これはLaravelがサポートしている全てのデータベースで上手く動作し、共通のAPIを持っています。The Laravel Schema class provides a database agnostic way of manipulating tables. It works well with all of the databases supported by Laravel, and has a unified API across all of these systems.

テーブル作成／削除Creating & Dropping Tables

テーブルを作成するには、Schema::createメソッドを使用します。To create a new database table, the Schema::create method is used:

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

createメソッドの最初の引数はテーブル名で、２つ目は無名関数です。新しいテーブルを定義するためのBlueprintオブジェクトを取ります。The first argument passed to the create method is the name of the table, and the second is a Closure which will receive a Blueprint object which may be used to define the new table.

存在しているテーブルの名前を変更するにはrenameメソッドを使用してください。To rename an existing database table, the rename method may be used:

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

スキーマ操作のコネクションを指定するには、Schema::connectionメソッドを最初に使用します。To specify which connection the schema operation should take place on, use the Schema::connection method:

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

テーブルをドロップするためには、Schema::dropメソッドを使用します。To drop a table, you may use the Schema::drop method:

Schema::drop('users');

Schema::dropIfExists('users');

カラム追加Adding Columns

既に存在するテーブルを更新するには、Schema::tableメソッドを使用します。To update an existing table, we will use the Schema::table method:

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

テーブルビルダーは構築に使用する様々なカラムのタイプで構成されています。The table builder contains a variety of column types that you may use when building your tables:

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

MySQLデータベースをお使いでしたら、afterメソッドでカラムの順番を指定することができます。If you are using the MySQL database, you may use the after method to specify the order of columns:

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

カラム名変更Renaming Columns

カラム名を変更するためにはrenameColumnメソッドをスキーマビルダーで使用してください。カラム名を変更する前に、composer.jsonファイルでdoctrine/dbalを依存パッケージとして追加済みであることを確認してください。To rename a column, you may use the renameColumn method on the Schema builder. Before renaming a column, be sure to add the doctrine/dbal dependency to your composer.json file.

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

注目： enumカラムタイプのリネームはサポートしていません。Note: Renaming enum column types is not supported.

カラム削除Dropping Columns

カラムをドロップするには、スキーマビルダーのdropColumnメソッドを使用します。カラムをドロップする前に、composer.jsonファイルへdoctrine/dbal依存パッケージを確実に追加してください。To drop a column, you may use the dropColumn method on the Schema builder. Before dropping a column, be sure to add the doctrine/dbal dependency to your composer.json file.

データベーステーブルからカラムをドロップするDropping A Column From A Database Table

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

データベーステーブルから複数のカラムをドロップするDropping Multiple Columns From A Database Table

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

存在チェックChecking Existence

テーブルの存在をチェックするChecking For Existence Of Table

hasTableやhasColumnを使用し簡単にテーブル、カラムが存在するかチェックできます。You may easily check for the existence of a table or column using the hasTable and hasColumn methods:

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

カラムの存在をチェックするChecking For Existence Of Columns

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

インデックス追加Adding Indexes

スキーマビルダーは様々なインデックスタイプをサポートしています。追加方法は２つあります。カラムの定義と同時に記述する方法と、後から追加する方法です。The schema builder supports several types of indexes. There are two ways to add them. First, you may fluently define them on a column definition, or you may add them separately:

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

もしくは、別の行でインデックスを追加することを選べます。指定可能なインデックスタイプの一覧です。Or, you may choose to add the indexes on separate lines. Below is a list of all available index types:

外部キーForeign Keys

Laravelはテーブル対する、外部キー束縛の追加も提供しています。Laravel also provides support for adding foreign key constraints to your tables:

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

この例では、user_idカラムがusersテーブルのidカラムを参照していることを宣言しています。外部キーカラムを最初に作成するのを忘れないでください。In this example, we are stating that the user_id column references the id column on the users table. Make sure to create the foreign key column first!

さらに束縛に対して「デリート時(on delete)」と「更新時(on update)」に対する処理をオプションとして指定できます。You may also specify options for the "on delete" and "on update" actions of the constraint:

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

外部キーを削除するには、dropForeignメソッドを使用します。他のインデックスで使用されるものと似た命名規則が外部キーにも使用されています。To drop a foreign key, you may use the dropForeign method. A similar naming convention is used for foreign keys as is used for other indexes:

$table->dropForeign('posts_user_id_foreign');

**注目：**自動増分する整数として参照される外部キーを作成する場合、外部キーの項目作成時はいつでもunsignedを付けるのをお忘れなく。Note: When creating a foreign key that references an incrementing integer, remember to always make the foreign key column unsigned.

インデックス削除Dropping Indexes

インデックスを削除する場合、インデックスの名前を指定します。Laravelはデフォルトで意味が通る名前をインデックスに付けます。シンプルにテーブル名、カラム名、インデックスタイプをつなげたものです。いくつか例をご覧ください。To drop an index you must specify the index's name. Laravel assigns a reasonable name to the indexes by default. Simply concatenate the table name, the names of the column in the index, and the index type. Here are some examples:

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

timestamps、nullableTimestamps、softDeletesの絡むタイプを削除するためには、以下のメソッドが使用できます。To drop the timestamps, nullableTimestamps or softDeletes column types, you may use the following methods:

ストレージエンジンStorage Engines

テーブルにストレージエンジンを設定するには、engineプロパティーをスキーマビルダーにセットしてください。To set the storage engine for a table, set the engine property on the schema builder:

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

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