PostgreSQL は django.contrib.postgres.constraints モジュールから利用できる追加のデータ整合性制約をサポートしています。これらはモデル Meta.constraints オプションで追加されます。
ExclusionConstraintLink to this heading#データベースに排他制約を作成します。内部的には、PostgreSQLはインデックスを使用して排他制約を実装しています。デフォルトのインデックス型は GiST です。インデックスを使用するには、PostgreSQLで btree_gist extension を有効にする必要があります。 BtreeGistExtension マイグレーションオペレーションを使ってインストールできます。
既存の行と競合する新しい行を挿入しようとすると、IntegrityError が発生します。更新が既存の行と競合する場合も同様です。
排他制約は モデル バリデーション の間にチェックされます。
\nnameLink to this heading#BaseConstraint.name を参照。
expressionsLink to this heading#2値タプルのイテラブル。最初の要素は式または文字列。2番目の要素は文字列で表現された SQL 演算子です。タイプミスを避けるために、演算子を文字列でマップする RangeOperators を使用できます。たとえば:
expressions = [\n ("timespan", RangeOperators.ADJACENT_TO),\n (F("room"), RangeOperators.EQUAL),\n]\nOpClass() 式は、制約式のカスタム operator class を指定するために使用できます。たとえば:
expressions = [\n (OpClass("circle", name="circle_ops"), RangeOperators.OVERLAPS),\n]\nこれは circle_ops を使用して circle 上に排他制約を作成します。
index_typeLink to this heading#制約のインデックスタイプです。受け入れられる値は GIST または SPGIST です。大文字小文字を区別しません。指定されていない場合、デフォルトのインデックスタイプは GIST です。
conditionLink to this heading#行の一部に制約をかける条件を指定する Q オブジェクト。たとえば、 condition=Q(cancelled=False) 。
これらの条件は、 django.db.models.Index.condition と同じデータベースの制約事項を持ちます。
deferrableLink to this heading#遅延可能な排他制約を作成するには、このパラメータを設定します。使用可能な値は Deferrable.DEFERRED または Deferrable.IMMEDIATE です。例:
from django.contrib.postgres.constraints import ExclusionConstraint\nfrom django.contrib.postgres.fields import RangeOperators\nfrom django.db.models import Deferrable\n\nExclusionConstraint(\n name="exclude_overlapping_deferred",\n expressions=[\n ("timespan", RangeOperators.OVERLAPS),\n ],\n deferrable=Deferrable.DEFERRED,\n)\nデフォルトでは、制約は遅延 (DEFERRED) されません。遅延された制約は、トランザクションが終了するまで実行されません。即時 (IMMEDIATE) 制約は、すべてのコマンドの直後に実行されます。
\n\nincludeLink to this heading#非キー列としてカバリング排他制約に含めるフィールド名のリストまたはタプル。これにより、含まれるフィールドのみを選択し (include)、インデックス化されたフィールドのみでフィルタリングする (expressions) クエリにインデックスのみのスキャンを使用できます。
include は GiST インデックスでサポートされています。PostgreSQL 14+ では、SP-GiST インデックスでも include がサポートされています。
violation_error_codeLink to this heading#モデルのバリデーション 中に ValidationError が発生した場合に使用されるエラーコードです。デフォルトは None です。
violation_error_messageLink to this heading#モデルのバリデーション 中に ValidationError が発生した場合に使用されるエラーメッセージです。デフォルトは BaseConstraint.violation_error_message です。
次の例では、キャンセルされた予約を考慮せずに、同じ部屋での重複する予約を制限しています。
\nfrom django.contrib.postgres.constraints import ExclusionConstraint\nfrom django.contrib.postgres.fields import DateTimeRangeField, RangeOperators\nfrom django.db import models\nfrom django.db.models import Q\n\n\nclass Room(models.Model):\n number = models.IntegerField()\n\n\nclass Reservation(models.Model):\n room = models.ForeignKey("Room", on_delete=models.CASCADE)\n timespan = DateTimeRangeField()\n cancelled = models.BooleanField(default=False)\n\n class Meta:\n constraints = [\n ExclusionConstraint(\n name="exclude_overlapping_reservations",\n expressions=[\n ("timespan", RangeOperators.OVERLAPS),\n ("room", RangeOperators.EQUAL),\n ],\n condition=Q(cancelled=False),\n ),\n ]\nモデルが2つのフィールドを使用して範囲を定義する場合、PostgreSQLのネイティブな範囲型ではなく、同等の関数 (例えば TsTzRange()) を使用する式を記述し、フィールドの区切り文字を使用する必要があります。ほとんどの場合、区切り文字は '[)' となり、下限は包括的で上限は排他的であることを意味します。 範囲境界 の式マッピングを提供する RangeBoundary を使用できます。たとえば:
from django.contrib.postgres.constraints import ExclusionConstraint\nfrom django.contrib.postgres.fields import (\n DateTimeRangeField,\n RangeBoundary,\n RangeOperators,\n)\nfrom django.db import models\nfrom django.db.models import Func, Q\n\n\nclass TsTzRange(Func):\n function = "TSTZRANGE"\n output_field = DateTimeRangeField()\n\n\nclass Reservation(models.Model):\n room = models.ForeignKey("Room", on_delete=models.CASCADE)\n start = models.DateTimeField()\n end = models.DateTimeField()\n cancelled = models.BooleanField(default=False)\n\n class Meta:\n constraints = [\n ExclusionConstraint(\n name="exclude_overlapping_reservations",\n expressions=[\n (\n TsTzRange("start", "end", RangeBoundary()),\n RangeOperators.OVERLAPS,\n ),\n ("room", RangeOperators.EQUAL),\n ],\n condition=Q(cancelled=False),\n ),\n ]\n