このモジュールで定義されたクラスはデータベース制約を作成します。これらはモデルの Meta.constraints オプションで追加されます。
BaseConstraintLink to this heading#すべての制約の基底クラスです。サブクラスは constraint_sql(), create_sql(), remove_sql(), validate() メソッドを実装しなければなりません。
すべての制約 (constraint) に共通するパラメータは以下の通りです：
\nnameLink to this heading#制約の名前。制約には常に一意な名前を指定する必要があります。
\nviolation_error_codeLink to this heading#モデルのバリデーション 中に ValidationError が発生した場合に使用されるエラーコードです。デフォルトは None です。
violation_error_messageLink to this heading#モデルのバリデーション の実行中に ValidationError が発生した場合に表示されるエラーメッセージです。デフォルトは "Constraint "%(name)s" is violated." です。
validate()Link to this heading#モデル model で定義された制約がインスタンス instance で守られているかどうかを検証します。これは、制約が守られていることを確認するために、データベースに対してクエリを実行します。制約を検証するために exclude リストのフィールドが必要な場合、制約は無視されます。
制約に違反した場合は ValidationError を発生させます。
このメソッドはサブクラスで実装する必要があります。
\nCheckConstraintLink to this heading#データベースにチェック制約を作成します。
\nconditionLink to this heading#制約が強制する条件チェックを指定する Q オブジェクトまたは真偽値の Expression です。
例:
\nCheckConstraint(condition=Q(age__gte=18), name="age_gte_18")\n年齢フィールドが18未満にならないことを保証します。
\n\n\n\nUniqueConstraintLink to this heading#データベースにユニーク制約（一意性制約）を作成します。
\nexpressionsLink to this heading#位置引数 *expressions により、式やデータベース関数に対する関数的なユニーク制約を作成できます。
例:
\nUniqueConstraint(Lower("name").desc(), "category", name="unique_lower_name_category")\nこれは name フィールドの小文字の値を降順で、category フィールドの値をデフォルトの昇順でユニーク制約を作成します。
関数的なユニーク制約は Index.expressions と同じデータベース制約を持ちます。
fieldsLink to this heading#制約を適用したい一意な列のセットを表すフィールド名のリスト。
\n例:
\nUniqueConstraint(fields=["room", "date"], name="unique_booking")\nそれぞれの部屋がそれぞれの日付で1度だけ予約できることを保証します。
\nconditionLink to this heading#制約を適用したい条件を指定する Q オブジェクト。
例:
\nUniqueConstraint(fields=["user"], condition=Q(status="DRAFT"), name="unique_draft_user")\nこれは、各ユーザーが1つの DRAFT しか持たないことを保証します。
\nこれらの condition は Index.condition と同じデータベースの制限を持ちます。
deferrableLink to this heading#このパラメータを指定すると、遅延可能なユニーク制約を作成できます。使用可能な値は Deferrable.DEFERRED または Deferrable.IMMEDIATE です。例えば：
from django.db.models import Deferrable, UniqueConstraint\n\nUniqueConstraint(\n name="unique_order",\n fields=["order"],\n deferrable=Deferrable.DEFERRED,\n)\nデフォルトでは、制約は遅延 (DEFERRED) されません。遅延された制約は、トランザクションが終了するまで実行されません。即時 (IMMEDIATE) 制約は、すべてのコマンドの直後に実行されます。
\n\n\nincludeLink to this heading#ユニークなカバリングインデックス (covering index) に非キー列として含めるフィールド名のリストまたはタプル。これにより、include されたフィールドだけを SELECT するクエリと、 (include)、ユニークなフィールドだけでフィルタリングする(fields) クエリにインデックスだけのスキャンを使用できます。
例:
\nUniqueConstraint(name="unique_booking", fields=["room", "date"], include=["full_name"])\nこの設定では、room と date によるフィルタリング、full_name の SELECT の際にデータをインデックスからのみ取得します。
PostgreSQL以外のデータベースでは、非キー列を持つユニーク制約は無視されます。
\n非キーカラムは Index.include と同じデータベース制約を持ちます。
opclassesLink to this heading#この一意なインデックスに使用する PostgreSQL operator クラス の名前です。カスタム演算子クラスが必要な場合は、インデックスの各フィールドに1つずつ指定しなければなりません。
\n例:
\nUniqueConstraint(\n name="unique_username", fields=["username"], opclasses=["varchar_pattern_ops"]\n)\nこれは username に varchar_pattern_ops を使用する一意なインデックスを作成します。
opclasses はPostgreSQL以外のデータベースでは無視されます。
nulls_distinctLink to this heading#ユニーク制約の対象となる NULL 値を含む行を、互いに異なる行とみなすかどうかを指定します。デフォルト値は None で、ほとんどのバックエンドで True となるデータベースのデフォルト値を使用します。
例:
\nUniqueConstraint(name="ordering", fields=["ordering"], nulls_distinct=False)\nこれは、 ordering カラムに NULL 値を格納できるのは1行だけというユニーク制約を作成します。
nulls_distinct によるユニーク制約は、PostgreSQL 15+ 以外のデータベースでは無視されます。
violation_error_codeLink to this heading#model validation 中に ValidationError が発生した場合に使用されるエラーコードです。
UniqueConstraint.condition が設定されているか、 UniqueConstraint.fields が設定されていない場合、デフォルトで BaseConstraint.violation_error_code になります。
UniqueConstraint.condition を伴わずに UniqueConstraint.fields が設定された場合、フィールドが複数あるときは Meta.unique_together のエラーコードがデフォルトとなり、フィールドが単一のときは Field.unique のエラーコードがデフォルトとなります。
violation_error_messageLink to this heading#model validation 中に ValidationError が発生した場合に使用されるエラーメッセージです。
UniqueConstraint.condition が設定されているか、 UniqueConstraint.fields が設定されていない場合、 BaseConstraint.violation_error_message がデフォルトになります。
UniqueConstraint.condition を伴わずに UniqueConstraint.fields が設定された場合、フィールドが複数あるときは Meta.unique_together のエラーメッセージがデフォルトとなり、フィールドが単一のときは Field.unique のエラーメッセージがデフォルトとなります。