PostgreSQL offre des contraintes d’intégrité de données supplémentaires dans le module django.contrib.postgres.constraints. Elles sont ajoutées dans l’option Meta.constraints des modèles.
ExclusionConstraintLien vers cette rubrique#Crée une contrainte d’exclusion dans la base de données. En interne, PostgreSQL implémente les contraintes d’exclusion par des index. Le type d’index par défaut est GiST. Pour les utiliser, vous devez activer l’extension btree_gist dans PostgreSQL. Vous pouvez installer l’extension par une opération de migration BtreeGistExtension.
Si vous essayez d’insérer une nouvelle ligne qui entre en conflit avec une ligne existante, une erreur IntegrityError se produit. De même lorsqu’un conflit survient lors d’une mise à jour.
Les contraintes d’exclusion sont vérifiées durant la validation des modèles.
\n\nnameLien vers cette rubrique#Voir BaseConstraint.name.
expressionsLien vers cette rubrique#Un itérable de tuples binaires. Le premier élément est une expression ou une chaîne. Le second élément est un opérateur SQL sous forme de chaîne. Pour éviter les erreurs syntaxiques, vous pouvez utiliser RangeOperators qui fait correspondre les opérateurs à des chaînes. Par exemple
expressions = [\n ("timespan", RangeOperators.ADJACENT_TO),\n (F("room"), RangeOperators.EQUAL),\n]\nL’expression OpClass() peut être utilisée pour indiquer une classe d’opérateur personnalisée pour les expressions de contrainte. Par exemple
expressions = [\n (OpClass("circle", name="circle_ops"), RangeOperators.OVERLAPS),\n]\ncrée une contrainte d’exclusion sur circle en utilisant circle_ops.
index_typeLien vers cette rubrique#Le type d’index de la contrainte. La valeurs admises sont GIST ou SPGIST. Les correspondances ne tiennent pas compte de la casse. En cas d’absence, le type d’index par défaut est GIST.
conditionLien vers cette rubrique#Un objet Q qui indique la condition de restriction d’une contrainte à un sous-ensemble de lignes. Par exemple, condition=Q(annule=False).
Ces conditions sont soumises aux mêmes restrictions de base de données que django.db.models.Index.condition.
deferrableLien vers cette rubrique#Définissez ce paramètre pour créer une contrainte d’exclusion différable. Les valeurs acceptées sont Deferrable.DEFERRED ou Deferrable.IMMEDIATE. Par exemple
from django.contrib.postgres.constraints import ExclusionConstraint\nfrom django.contrib.postgres.fields import RangeOperators\nfrom django.db.models import Deferrable\n\n\nExclusionConstraint(\n name="exclude_overlapping_deferred",\n expressions=[\n ("timespan", RangeOperators.OVERLAPS),\n ],\n deferrable=Deferrable.DEFERRED,\n)\nPar défaut, les contraintes ne sont pas différées. Une contrainte différée ne sera pas appliquée avant la fin de la transaction. Une contrainte immédiate sera appliquée immédiatement après chaque commande.
\n\nincludeLien vers cette rubrique#Une liste ou un tuple de noms de champs à inclure dans la contrainte d’exclusion de couverture, représentant des colonnes qui ne sont pas des clés. Cela permet des analyses en index pur avec des requêtes qui ne sélectionnent que les champs inclus (include) et qui ne filtrent que sur les champs indexés (expressions).
include est pris en charge par les index GiST. PostgreSQL 14+ prend aussi en charge include pour les index SP-GiST.
opclassesLien vers cette rubrique#Les noms des classes d’opérateurs PostgreSQL à utiliser pour cette contrainte. Si vous nécessitez une classe d’opérateur personnalisée, vous devez en fournir une pour chaque expression de la contrainte.
\nPar exemple :
\nExclusionConstraint(\n name="exclude_overlapping_opclasses",\n expressions=[("circle", RangeOperators.OVERLAPS)],\n opclasses=["circle_ops"],\n)\ncrée une contrainte d’exclusion sur circle en utilisant circle_ops.
violation_error_messageLien vers cette rubrique#Le message d’erreur utilisé lorsque ValidationError est générée pendant la phase de validation des modèles. Contient par défaut BaseConstraint.violation_error_message.
L’exemple suivant évite les chevauchements de réservations d’une même salle, sans tenir compte des réservations annulées
\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 ]\nDans le cas où un modèle définit un intervalle avec deux champs, au lieu des types d’intervalle natifs de PostgreSQL, vous devriez écrire une expression qui utilise la fonction équivalente (par ex. TsTzRange()), et utiliser les délimiteurs du champ. La plupart du temps, les délimiteurs seront '[)', ce qui signifie que la limite inférieure est inclusive et la limite supérieure exclusive. Vous pouvez utiliser RangeBoundary qui fournit des correspondances d’expression pour les limites d’intervalle. Par exemple
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