use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
public function up(): void
{
Schema::create('users', function (Blueprint $table) {
$table->id()->comment('ユーザーID');
$table->string('name')->comment('ユーザー名');
$table->string('email')->unique()->comment('メールアドレス');
$table->timestamps();
// テーブル全体にコメントを付ける
$table->comment('ユーザー情報を保存するテーブル');
});
}
public function down(): void
{
Schema::dropIfExists('users');
}
};
上記のようなマイグレーションファイルを作成し、実行すればOKです。
既存テーブルにコメントを追加する場合
既存テーブルにコメントを付ける方法を解説します。
STEP
マイグレーションファイルの作成
use Illuminate\Database\Migrations\Migration;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
public function up(): void
{
Schema::table('users', function ($table) {
// 既存テーブルにコメントを付ける
$table->comment('ユーザー情報テーブル(認証用)');
});
}
public function down(): void
{
Schema::table('users', function ($table) {
// コメントを削除する(空にする)
$table->comment(null);
});
}
};