Les classes définies dans ce module créent des contraintes de base de données. Elles sont ajoutées dans l’option Meta.constraints des modèles.
BaseConstraintLien vers cette rubrique#Classe de base pour toutes les contraintes. Les sous-classes doivent implémenter les méthodes constraint_sql(), create_sql(), remove_sql() et validate().
Toutes les contraintes partagent les paramètres suivants :
\nnameLien vers cette rubrique#Le nom de la contrainte. La contrainte doit toujours posséder un nom unique.
\nviolation_error_messageLien vers cette rubrique#The error message used when ValidationError is raised during\nmodel validation. Defaults to\n"Constraint “%(name)s” is violated.".
validate()Lien vers cette rubrique#Validates that the constraint, defined on model, is respected on the\ninstance. This will do a query on the database to ensure that the\nconstraint is respected. If fields in the exclude list are needed to\nvalidate the constraint, the constraint is ignored.
Raise a ValidationError if the constraint is violated.
This method must be implemented by a subclass.
\nCheckConstraintLien vers cette rubrique#Crée une contrainte de vérification dans la base de données.
\ncheckLien vers cette rubrique#Un objet Q ou une Expression booléenne qui indique le contrôle que la contrainte souhaitée doit appliquer.
Par exemple, CheckConstraint(check=Q(age__gte=18), name='age_gte_18') s’assure que le champ age n’est jamais au-dessous de 18.
UniqueConstraintLien vers cette rubrique#Crée une contrainte d’unicité dans la base de données.
\nexpressionsLien vers cette rubrique#L’argument positionnel *expressions permet de créer des contraintes d’unicité fonctionnelles sur des expressions et des fonctions de base de données.
Par exemple :
\nUniqueConstraint(Lower('name').desc(), 'category', name='unique_lower_name_category')\ncrée une contrainte d’unicité sur la valeur en minuscules du champ name dans l’ordre alphabétique inverse et le champ category dans l’ordre alphabétique par défaut.
Les contraintes d’unicité basées sur des fonctions sont soumises aux même restrictions de base de données que Index.expressions.
fieldsLien vers cette rubrique#Une liste de noms de champs qui précise l’ensemble unique de colonnes pour lesquelles la contrainte va assurer l’unicité.
\nPar exemple, UniqueConstraint(fields=['chambre', 'date'], name='reservation_unique') s’assure que chaque chambre ne peut être réservée qu’une seule fois par date.
conditionLien vers cette rubrique#Un objet Q qui indique la condition que la contrainte souhaitée doit appliquer.
Par exemple :
\nUniqueConstraint(fields=['user'], condition=Q(status='DRAFT'), name='unique_draft_user')\ns’assure que chaque utilisateur dispose d’un seul brouillon.
\nCes conditions sont soumises aux même restrictions de base de données que Index.condition.
deferrableLien vers cette rubrique#Définissez ce paramètre pour créer une contrainte d’unicité différable. Les valeurs acceptées sont Deferrable.DEFERRED ou Deferrable.IMMEDIATE. Par exemple
from django.db.models import Deferrable, UniqueConstraint\n\nUniqueConstraint(\n name='unique_order',\n fields=['order'],\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\n\nincludeLien vers cette rubrique#Une liste ou un tuple de noms de champs à inclure dans l’index unique couvrant, 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 (fields).
Par exemple :
\nUniqueConstraint(name='unique_booking', fields=['room', 'date'], include=['full_name'])\npermettra le filtrage sur room et date, sélectionnant aussi full_name, tout en ne récupérant les données qu’à partir de l’index.
include n’est pris en charge que par PostgreSQL.
Les colonnes qui ne sont pas des clés sont soumises aux même restrictions de base de données que pour Index.include.
opclassesLien vers cette rubrique#Les noms des classes d’opérateurs PostgreSQL à utiliser pour cet index unique. Si vous nécessitez une classe d’opérateur personnalisée, vous devez en fournir une pour chaque champ de l’index.
\nPar exemple :
\nUniqueConstraint(name='unique_username', fields=['username'], opclasses=['varchar_pattern_ops'])\ncrée un index unique sur username en utilisant varchar_pattern_ops.
opclasses est ignoré pour les bases de données autres que PostgreSQL.
violation_error_messageLien vers cette rubrique#The error message used when ValidationError is raised during\nmodel validation. Defaults to\nBaseConstraint.violation_error_message.
This message is not used for UniqueConstraints with\nfields and without a\ncondition. Such UniqueConstraints show the\nsame message as constraints defined with\nField.unique or in\nMeta.unique_together.