データベースレベルでモデルフィールドのデフォルト値を設定: Django 5.0の新機能

django.db.models.Field.db_default は、Django 5.0 で導入された新しい機能で、モデルフィールドのデフォルト値をデータベースレベルで設定するためのものです。従来の default 属性とは異なり、db_default はデータベースに格納される実際のデフォルト値を定義します。

利点

デフォルト値の変更を容易にします。
アプリケーションコードを簡潔に保ちやすくなります。
データベースとの整合性を保ちやすくなります。

使い方

db_default 属性は、モデルフィールドの定義時に設定します。以下の例のように、値を直接指定したり、呼び出し可能なオブジェクトを設定したりできます。

from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255, db_default='John Doe')
    created_at = models.DateTimeField(db_default=models.functions.now())

default 属性との違い

db_default 属性と従来の default 属性は、以下の点で異なります。

優先順位
両方が設定されている場合、default が優先されます。
適用タイミング
db_default は新しいレコードが作成されるときに適用され、default は新しいレコードが作成されるときと、save() メソッドが呼び出されるときに適用されます。
設定場所
db_default はデータベースに格納され、default はアプリケーションコードに格納されます。

既存のデータベーススキーマを変更する場合は、慎重に行う必要があります。
db_default 属性は、データベースがサポートする型のみを使用できます。

db_default 属性は、すべてのデータベースでサポートされているわけではありません。
db_default 属性は、Django 5.0 以降でのみ使用できます。

例 1: 単純な値

この例では、name フィールドのデフォルト値を "John Doe" に設定します。

from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255, db_default='John Doe')

例 2: 呼び出し可能なオブジェクト

この例では、created_at フィールドのデフォルト値を現在時刻に設定します。

from django.db import models

class MyModel(models.Model):
    created_at = models.DateTimeField(db_default=models.functions.now())

例 3: カスタム関数

この例では、age フィールドのデフォルト値をランダムな整數に設定します。

from django.db import models
import random

def random_age():
    return random.randint(18, 65)

class MyModel(models.Model):
    age = models.IntegerField(db_default=random_age)

例 4: 既存のデータベーススキーマの変更

この例では、既存のデータベーススキーマに db_default 属性を追加する方法を示します。

ALTER TABLE my_app_mymodel
ALTER COLUMN created_at SET DEFAULT NOW();

既存のデータベーススキーマを変更する場合は、慎重に行う必要があります。
db_default 属性は、データベースがサポートする型のみを使用できます。

Django の django.db.models.Field.db_default 属性は、モデルフィールドのデフォルト値をデータベースレベルで設定するための便利な機能です。しかし、いくつかの状況では、db_default の代替方法が必要になる場合があります。

代替方法

以下に、db_default の代替方法をいくつか紹介します。

default 属性を使用する

default 属性は、モデルフィールドの定義時に設定する従来の方法です。db_default と異なり、default はアプリケーションコードに格納されます。

from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255, default='John Doe')

シグナルを使用する

シグナルを使用して、新しいレコードが作成されるときにデフォルト値を設定することができます。

from django.db.models.signals import post_save
from django.dispatch import receiver

@receiver(post_save, sender=MyModel)
def set_default_value(sender, instance, created, **kwargs):
    if created:
        instance.name = 'John Doe'
        instance.save()

モデルの save() メソッドをオーバーライドする

モデルの save() メソッドをオーバーライドして、デフォルト値を設定することができます。

from django.db import models

class MyModel(models.Model):
    name = models.CharField(max_length=255)

    def save(self, *args, **kwargs):
        if not self.name:
            self.name = 'John Doe'
        super().save(*args, **kwargs)

カスタムバリデーションを使用する

カスタムバリデーションを使用して、デフォルト値を設定することができます。

from django.core.validators import ValidationError

def validate_default_value(value):
    if not value:
        raise ValidationError('This field cannot be empty.')

class MyModel(models.Model):
    name = models.CharField(max_length=255, validators=[validate_default_value])

db_default を使用する場合は、その利点と制限を理解した上で使用してください。
状況に合わせて適切な方法を選択してください。
上記の代替方法は、それぞれ一長一短があります。