djangodocs

Django 5.1
日本語
Documentation contents

制約 (Constraint) リファレンス

このモジュールで定義されたクラスはデータベース制約を作成します。これらはモデルの Meta.constraints オプションで追加されます。

BaseConstraint

class BaseConstraint(*name, violation_error_code=None, violation_error_message=None)

すべての制約の基底クラスです。サブクラスは constraint_sql(), create_sql(), remove_sql(), validate() メソッドを実装しなければなりません。

すべての制約 (constraint) に共通するパラメータは以下の通りです：

name

BaseConstraint.name

制約の名前。制約には常に一意な名前を指定する必要があります。

violation_error_code

BaseConstraint.violation_error_code

モデルのバリデーション 中に ValidationError が発生した場合に使用されるエラーコードです。デフォルトは None です。

violation_error_message

BaseConstraint.violation_error_message

モデルのバリデーション の実行中に ValidationError が発生した場合に表示されるエラーメッセージです。デフォルトは "Constraint "%(name)s" is violated." です。

validate()

BaseConstraint.validate(model, instance, exclude=None, using=DEFAULT_DB_ALIAS)

モデル model で定義された制約がインスタンス instance で守られているかどうかを検証します。これは、制約が守られていることを確認するために、データベースに対してクエリを実行します。制約を検証するために exclude リストのフィールドが必要な場合、制約は無視されます。

制約に違反した場合は ValidationError を発生させます。

このメソッドはサブクラスで実装する必要があります。

CheckConstraint

class CheckConstraint(*, condition, name, violation_error_code=None, violation_error_message=None)

データベースにチェック制約を作成します。

condition

CheckConstraint.condition

制約が強制する条件チェックを指定する Q オブジェクトまたは真偽値の Expression です。

例えば、CheckConstraint(condition=Q(age__gte=18), name='age_gte_18') は、age フィールドが18未満でないことを保証します。

UniqueConstraint

class UniqueConstraint(*expressions, fields=(), name=None, condition=None, deferrable=None, include=None, opclasses=(), nulls_distinct=None, violation_error_code=None, violation_error_message=None)

データベースにユニーク制約（一意性制約）を作成します。

expressions

UniqueConstraint.expressions

位置引数 *expressions により、式やデータベース関数に対する関数的なユニーク制約を作成できます。

例:

Code
UniqueConstraint(Lower("name").desc(), "category", name="unique_lower_name_category")

これは name フィールドの小文字の値を降順で、category フィールドの値をデフォルトの昇順でユニーク制約を作成します。

関数的なユニーク制約は Index.expressions と同じデータベース制約を持ちます。

fields

UniqueConstraint.fields

制約を適用したい一意な列のセットを表すフィールド名のリスト。

例えば、UniqueConstraint(fields=['room', 'date'], name='unique_booking') は各 room が各 date で一度しか予約できないようにします。

condition

UniqueConstraint.condition

制約を適用したい条件を指定する Q オブジェクト。

例:

Code
UniqueConstraint(fields=["user"], condition=Q(status="DRAFT"), name="unique_draft_user")

これは、各ユーザーが1つの DRAFT しか持たないことを保証します。

これらの condition は Index.condition と同じデータベースの制限を持ちます。

deferrable

UniqueConstraint.deferrable

このパラメータを指定すると、遅延可能なユニーク制約を作成できます。使用可能な値は Deferrable.DEFERRED または Deferrable.IMMEDIATE です。例えば：

Code
from django.db.models import Deferrable, UniqueConstraint

UniqueConstraint(
    name="unique_order",
    fields=["order"],
    deferrable=Deferrable.DEFERRED,
)

デフォルトでは、制約は遅延 (DEFERRED) されません。遅延された制約は、トランザクションが終了するまで実行されません。即時 (IMMEDIATE) 制約は、すべてのコマンドの直後に実行されます。

include

UniqueConstraint.include

ユニークなカバリングインデックス (covering index) に非キー列として含めるフィールド名のリストまたはタプル。これにより、include されたフィールドだけを SELECT するクエリと、 (include)、ユニークなフィールドだけでフィルタリングする(fields) クエリにインデックスだけのスキャンを使用できます。

例:

Code
UniqueConstraint(name="unique_booking", fields=["room", "date"], include=["full_name"])

この設定では、room と date によるフィルタリング、full_name の SELECT の際にデータをインデックスからのみ取得します。

PostgreSQL以外のデータベースでは、非キー列を持つユニーク制約は無視されます。

非キーカラムは Index.include と同じデータベース制約を持ちます。

opclasses

UniqueConstraint.opclasses

この一意なインデックスに使用する PostgreSQL operator クラス の名前です。カスタム演算子クラスが必要な場合は、インデックスの各フィールドに1つずつ指定しなければなりません。

例:

Code
UniqueConstraint(
    name="unique_username", fields=["username"], opclasses=["varchar_pattern_ops"]
)

これは username に varchar_pattern_ops を使用する一意なインデックスを作成します。

opclasses はPostgreSQL以外のデータベースでは無視されます。

nulls_distinct

UniqueConstraint.nulls_distinct

ユニーク制約の対象となる NULL 値を含む行を、互いに異なる行とみなすかどうかを指定します。デフォルト値は None で、ほとんどのバックエンドで True となるデータベースのデフォルト値を使用します。

例:

Code
UniqueConstraint(name="ordering", fields=["ordering"], nulls_distinct=False)

これは、 ordering カラムに NULL 値を格納できるのは1行だけというユニーク制約を作成します。

nulls_distinct によるユニーク制約は、PostgreSQL 15+ 以外のデータベースでは無視されます。

violation_error_code

UniqueConstraint.violation_error_code

モデルのバリデーション 中に ValidationError が発生した場合に使用されるエラーコードです。デフォルトは None です。

このコードは、fields を持ち、かつ condition を持たない UniqueConstraint には 使用されません 。このような UniqueConstraint は、Field.unique や Meta.unique_together で定義された制約と同じエラーコードを持ちます。

violation_error_message

UniqueConstraint.violation_error_message

モデルのバリデーション 中に ValidationError が発生した場合に使用されるエラーメッセージです。デフォルトは BaseConstraint.violation_error_message です。

このメッセージは、fields を持ち、かつ condition を持たない UniqueConstraint には 使用されません 。このような UniqueConstraint は、Field.unique や Meta.unique_together で定義された制約と同じメッセージを表示します。

This page as Markdown JSON

Edit this page on GitHub Official version