Laravelマイグレーション：$table->timestamps()でデフォルト値を現在の日時に設定

2024-04-13

Laravel マイグレーションでタイムスタンプ列のデフォルト値を現在の日時に設定する方法

Laravel マイグレーションでは、データベーステーブルの構造を定義することができます。テーブルには、さまざまなデータ型のカラムを定義できますが、その中には created_at と updated_at という、自動的に更新されるタイムスタンプ列が含まれています。

デフォルトでは、これらの列にはレコードが作成または更新されたときの現在の日時が設定されます。しかし、場合によっては、これらの列にデフォルト値として特定の日時を設定したい場合があります。

方法

Laravel マイグレーションでタイムスタンプ列のデフォルト値を現在の日時に設定するには、以下のいずれかの方法を使用できます。

$table->timestamps() メソッドを使用すると、created_at と updated_at 列が自動的に作成されます。これらの列には、レコードが作成または更新されたときの現在の日時がデフォルト値として設定されます。

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamps(); // created_at と updated_at 列が自動的に作成されます
    });
}

$table->timestamp('created_at') と $table->timestamp('updated_at') メソッドを使用して、created_at と updated_at 列を手動で作成することもできます。これらの列には、デフォルト値として NULL が設定されます。

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamp('created_at')->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定
        $table->timestamp('updated_at')->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定
    });
}

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamp('created_at', 0)->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定し、精度をミリ秒に設定
        $table->timestamp('updated_at', 0)->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定し、精度をミリ秒に設定
    });
}

補足

上記の例では、CURRENT_TIMESTAMP 関数を使用して、現在の日時を取得しています。
デフォルト値として特定の日時を設定したい場合は、DB::raw('2024-04-12 10:12:00') のような式を使用することができます。
Laravel 5.7 以降では、$table->timestampsTz() メソッドを使用して、タイムゾーン付きのタイムスタンプ列を作成することもできます。

Laravel マイグレーションでタイムスタンプ列のデフォルト値を現在の日時に設定するサンプルコード

$table->timestamps() メソッドを使用する

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamps(); // created_at と updated_at 列が自動的に作成されます
    });
}

このコードは、users という名前のテーブルを作成します。このテーブルには、id、name、email、email_verified_at、password、remember_token、created_at、updated_at という列が含まれます。

created_at と updated_at 列は、レコードが作成または更新されたときの現在の日時が自動的に設定されます。

$table->timestamp('created_at') と $table->timestamp('updated_at') メソッドを使用する

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamp('created_at')->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定
        $table->timestamp('updated_at')->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定
    });
}

このコードは、上記のコードと同じテーブルを作成しますが、created_at と updated_at 列のデフォルト値を CURRENT_TIMESTAMP に設定しています。

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamp('created_at', 0)->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定し、精度をミリ秒に設定
        $table->timestamp('updated_at', 0)->default('CURRENT_TIMESTAMP'); // デフォルト値を現在の日時に設定し、精度をミリ秒に設定
    });
}

Laravel マイグレーションでタイムスタンプ列のデフォルト値を現在の日時に設定するその他の方法

DB::raw() 関数を使用して、SQL 式を直接実行することができます。この方法を使用すると、より複雑なデフォルト値を設定することができます。

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamp('created_at')->default(DB::raw('NOW()')); // デフォルト値を現在の日時に設定
        $table->timestamp('updated_at')->default(DB::raw('CURRENT_TIMESTAMP')); // デフォルト値を現在の日時に設定
    });
}

カラム修飾子を使用する

Laravel 8 以降では、カラム修飾子を使用して、タイムスタンプ列のデフォルト値を現在の日時に設定することができます。

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamp('created_at')->default(now()); // デフォルト値を現在の日時に設定
        $table->timestamp('updated_at')->default(now()); // デフォルト値を現在の日時に設定
    });
}

ミューテーターを使用して、タイムスタンプ列の値を自動的に設定することもできます。

public function up()
{
    Schema::create('users', function (Blueprint $table) {
        $table->id();
        $table->string('name');
        $table->string('email')->unique();
        $table->timestamp('email_verified_at')->nullable();
        $table->password();
        $table->rememberToken();
        $table->timestamps();
    });
}

public function setCreatedAt($value)
{
    $this->created_at = now();
}

public function setUpdatedAt($value)
{
    $this->updated_at = now();
}

public function register()
{
    Event::listen(UserCreated::class, function (UserCreated $event) {
        $event->user->created_at = now();
        $event->user->updated_at = now();
        $event->user->save();
    });
}

注意事項