Справочник ограничений

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) [source]

Проверяет, соблюдается ли ограничение, определенное для model, на instance. Это выполнит запрос к базе данных для проверки соблюдения ограничения. Если поля в списке exclude необходимы для проверки ограничения, ограничение игнорируется.

Вызывает исключение ValidationError, если ограничение нарушено.

Этот метод должен быть реализован подклассом.

condition

CheckConstraint.condition

Объект Q или булево выражение Expression, которое определяет условную проверку, которую должно обеспечить ограничение.

Например, CheckConstraint(condition=Q(age__gte=18), name='age_gte_18') гарантирует, что поле age никогда не меньше 18.

CheckConstraint(
    condition=Q(age__gte=18) & Q(expensive_check=condition),
    name="age_gte_18_and_others",
)

CheckConstraint(condition=Q(age__gte=18) | Q(age__isnull=True), name="age_gte_18")

expressions

UniqueConstraint.expressions

Позиционный аргумент *expressions позволяет создавать функциональные уникальные ограничения на выражения и функции базы данных.

Например:

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

создаёт уникальное ограничение на значение поля name в нижнем регистре в порядке убывания и поле category в порядке возрастания по умолчанию.

Функциональные уникальные ограничения имеют те же ограничения базы данных, что и Index.expressions.

fields

UniqueConstraint.fields

Список имён полей, определяющих уникальный набор столбцов, для которых необходимо применить ограничение.

Например, UniqueConstraint(fields=['room', 'date'], name='unique_booking') гарантирует, что каждый номер комнаты может быть забронирован только один раз для каждой даты.

condition

UniqueConstraint.condition

Объект Q, определяющий условие, которое необходимо применить к ограничению.

Например:

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

обеспечивает, что у каждого пользователя только один черновик.

Эти условия имеют те же ограничения базы данных, что и Index.condition.

deferrable

UniqueConstraint.deferrable

Установите этот параметр, чтобы создать откладываемое уникальное ограничение. Допустимые значения — Deferrable.DEFERRED или Deferrable.IMMEDIATE. Например:

from django.db.models import Deferrable, UniqueConstraint

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

По умолчанию ограничения не откладываются. Отложенное ограничение не будет применяться до завершения транзакции. Немедленное ограничение будет применяться немедленно после каждой команды.

include

UniqueConstraint.include

Список или кортеж имён полей, которые будут включены в уникальный индекс в качестве столбцов, не являющихся ключевыми. Это позволяет использовать индексные только сканирования для запросов, которые выбирают только включенные поля (include) и фильтруют только по уникальным полям (fields).

Например:

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

позволит фильтровать по room и date, а также выбирать full_name, получая данные только из индекса.

Уникальные ограничения с столбцами, не являющимися ключевыми, игнорируются для баз данных, кроме PostgreSQL.

Столбцы, не являющиеся ключевыми, имеют те же ограничения базы данных, что и Index.include.

opclasses

UniqueConstraint.opclasses

Имена операторных классов PostgreSQL, которые следует использовать для данного уникального индекса. Если требуется пользовательский операторный класс, необходимо указать один для каждого поля в индексе.

Например:

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

создаёт уникальный индекс на username, используя varchar_pattern_ops.

opclasses игнорируются для баз данных, кроме PostgreSQL.

nulls_distinct

UniqueConstraint.nulls_distinct

Определяет, считаются ли строки, содержащие NULL значения, охваченные уникальным ограничением, различными друг от друга. Значение по умолчанию — None, которое использует значение по умолчанию базы данных, которое равно True для большинства бэкэндов.

Например:

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

создаёт уникальное ограничение, которое позволяет хранить только одну строку со значением NULL в столбце ordering.

Уникальные ограничения с nulls_distinct игнорируются для баз данных, кроме PostgreSQL 15+.

violation_error_code

UniqueConstraint.violation_error_code

Код ошибки, используемый при возникновении ошибки ValidationError во время проверки модели.

По умолчанию — BaseConstraint.violation_error_code, когда установлен либо UniqueConstraint.condition, либо UniqueConstraint.fields не установлен.

Если UniqueConstraint.fields установлен без UniqueConstraint.condition, по умолчанию используется код ошибки Meta.unique_together для нескольких полей и Field.unique — для одного поля.

violation_error_message

UniqueConstraint.violation_error_message

Сообщение об ошибке, используемое при возникновении ValidationError ошибки во время проверки модели.

По умолчанию — BaseConstraint.violation_error_message, когда установлен либо UniqueConstraint.condition, либо UniqueConstraint.fields не установлен.

Если UniqueConstraint.fields установлен без UniqueConstraint.condition, по умолчанию используется сообщение об ошибке Meta.unique_together для нескольких полей и Field.unique — для одного поля.