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

Классы, определённые в этом модуле, создают ограничения базы данных. Они добавляются в параметр модели Meta.constraints.

BaseConstraint

class BaseConstraint(name, violation_error_message=None)

Базовый класс для всех ограничений. Подклассы должны реализовать методы constraint_sql(), create_sql(), remove_sql() и validate().

У всех ограничений есть следующие общие параметры:

name

BaseConstraint.name

Имя ограничения. Вы всегда должны указать уникальное имя для ограничения.

violation_error_message

BaseConstraint.violation_error_message

Сообщение об ошибке, используемое при возникновении ValidationError во время проверки модели. По умолчанию "Constraint “%(name)s” is violated.".

validate()

BaseConstraint.validate(model, instance, exclude=None, using=DEFAULT_DB_ALIAS)

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

Вызвать ValidationError в случае нарушения ограничения.

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

CheckConstraint

class CheckConstraint(*, check, name, violation_error_message=None)

Создаёт ограничение проверки в базе данных.

check

CheckConstraint.check

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

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

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

UniqueConstraint

class UniqueConstraint(*expressions, fields=(), name=None, condition=None, deferrable=None, include=None, opclasses=(), violation_error_message=None)

Создаёт уникальное ограничение в базе данных.

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, извлекая данные только из индекса.

include поддерживается только в PostgreSQL.

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

opclasses

UniqueConstraint.opclasses

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

Например:

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

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

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

violation_error_message

UniqueConstraint.violation_error_message

Сообщение об ошибке, используемое при поднятии ValidationError во время валидации модели. По умолчанию равно BaseConstraint.violation_error_message.

Это сообщение не используется для UniqueConstraint с fields и без condition. Такие UniqueConstraint отображают то же сообщение, что и ограничения, определенные с помощью Field.unique или в Meta.unique_together.