データベースのカラムの設定（マイグレーションファイル）　まとめ

Laravel ではマイグレーションという便利な機能（データベースを管理する機能）が用意されています。

カラムの追加や削除はマイグレーションファイルで行います。

マイグレーション（新規作成）

マイグレーション（更新作業）

しかし、毎回、書き方を忘れてしまうんですよね。

そんなわけで、今回はマイグレーションファイルにおけるカラムの設定についてまとめました。

 
INDEX

書式

基本

例：nameカラムのデータ型を 「varchar」 に設定

$table->string('name');

カラム属性の変更

chengeメソッドは存在するカラムを新しいタイプへ変更するか、カラムの属性を変更します。

例：nameのカラムのサイズを25から50へ変更

$table->string('name', 50)->change();

 
例：さらにNULL値を設定可能にする

$table->string('name', 50)->nullable()->change();

public function down()
{
  Schema::table('users',function(Blueprint $table){
    # ---------------
    # 5.5 以前
    # ---------------
    DB::statement('ALTER TABLE users MODIFY name VARCHAR NOT NULL;');

    // SQL のバージョンによっては以下のような書き方になることも    
    DB::statement("ALTER TABLE `users` CHANGE `name` `name` VARCHAR(255) NOT NULL");

    # ---------------- 
    # 5.5 以降は以下の記述ができます。
    # ----------------
    // $table->string('name')->nullable(false)->change();
    });
  }
}

カラムの削除

ロールバックの項目（ down() ）でよく使います。

$table->dropColumn('name');

$table->dropColumn(['zip', 'country' , 'address']);

カラムの設定

データ型

// 外部キーのカラム
$table->unsignedBigInteger('user_id');

// 以下でもOK（laravel 7 以降）
// foreignId メソッドは unsignedBigInteger メソッドのエイリアスです。
$table->foreignId(‘user_id’);

$table->boolean('access_flg')->default(false);

$table->integer('product_code');

$table->string('title')->comment('タイトル');

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

$table->timestamps();

$table->text('memo')->comment('備考欄');

$table->softDeletes();

オプション（カラム修飾子）

   
    $table->string('name')->comment('なまえ');
   
   

   
    $table->text('memo')->nullable()->change();
   
   

   
   // 外部キー設定のときによく使います。
   $table->integer('user_id')->unsigned();
   
   

   
   // デフォルト値null設定
   $table->string('tag')->nullable()->default('NULL');

   $table->integer('sort_order')->unsigned()->default(0)->comment('並び順');
   
   

   
   # id カラムのあとに user_id カラムを追加
   # 逆の ->before() はないので注意！
   $table->integer('user_id')->after('id');
   
   

インデックス

   
    $table->integer('category_id')->index('category_id');
   
   

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

   
   // 外部キー設定のときによく使います。
   $table->integer('user_id')->unsigned();
   
   

外部キーの作成

例：rolesテーブルの user_id を外部キーとしてusersテーブルと紐づける。

外部キーを設定しておくと、rolesテーブルの user_id にusersテーブルの id が自動で入ってくれます。

public function up()
{
    Schema::table('roles', function (Blueprint $table){
        $table->integer('user_id')->unsigned()->change(); // 符号無し属性に変更
        $table->foreign('user_id')->references('id')->on('users'); // 外部キー参照
    });
}

実例

public function up()
{
	Schema::create('users', function(Blueprint $table)
	{
		$table->increments('id', true)->unsigned()->comment('ID');
		$table->string('family_name', 40)->comment('姓');
		$table->string('first_name', 40)->comment('名');
		$table->string('email')->unique('email')->comment('メールアドレス');
		$table->string('password')->comment('パスワード');
		$table->date('birthdate')->comment('生年月日');
		$table->tinyInteger('gender')->unsigned()->comment('性別 : 1 : 男性 2 : 女性');
		$table->string('zip', 10)->comment('郵便番号');
		$table->tinyInteger('prefecture_code')->unsigned()->comment('都道府県コード : JIS都道府県コード');
		$table->string('prefecture', 40)->comment('都道府県名 フリーテキスト検索で使用');
		$table->string('address')->comment('住所2');
		$table->string('tel', 20)->nullable()->comment('電話番号');
		$table->text('memo', 65535)->nullable()->comment('メッセージ');
		$table->rememberToken();
		$table->timestamps();
		$table->softDeletes()->comment('削除日時 : 削除・退会を行った日時  この値がnullでなかったら、削除・退会を行ったとみなす');
	});
}

 
また、何か発見したら追記していこうと思います。

以上です。

本庄マサノリ

仕事で Laravel を使っています。気づいたことや新しい発見など情報を発信していきます。問い合わせはこちら。

>> Twitter をフォローする

-周辺知識