Ограничения базы данных, специфичные для PostgreSQL

PostgreSQL поддерживает дополнительные ограничения целостности данных, доступные из модуля django.contrib.postgres.constraints. Они добавляются в опции модели Meta.constraints.

ExclusionConstraint

New in Django 3.0.
class ExclusionConstraint(*, name, expressions, index_type=None, condition=None, deferrable=None)[исходный код]

Создает исключающее ограничение в базе данных. Внутри PostgreSQL ограничения исключения реализуются с помощью индексов. Тип индекса по умолчанию - GiST. Чтобы использовать их, необходимо активировать btree_gist extension на PostgreSQL. Вы можете установить его с помощью операции миграции BtreeGistExtension.

Если вы пытаетесь вставить новый ряд, который конфликтует с существующим рядом, возникает ошибка IntegrityError. Аналогично, если обновление конфликтует с существующим рядом.

name

ExclusionConstraint.name

Имя ограничения.

expressions

ExclusionConstraint.expressions

Итерабельность из двух кортежей. Первый элемент - выражение или строка. Второй элемент - оператор SQL, представленный в виде строки. Чтобы избежать опечаток, вы можете использовать RangeOperators, который сопоставляет операторы со строками. Например:

expressions=[
    ('timespan', RangeOperators.ADJACENT_TO),
    (F('room'), RangeOperators.EQUAL),
]

Ограничения для операторов.

В ограничениях исключения могут использоваться только коммутативные операторы.

index_type

ExclusionConstraint.index_type

Тип индекса ограничения. Принимаются значения GIST или SPGIST. Сопоставление не чувствительно к регистру. Если значение не указано, то по умолчанию используется тип индекса GIST.

condition

ExclusionConstraint.condition

Объект Q, задающий условие для ограничения подмножества строк. Например, condition=Q(cancelled=False).

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

deferrable

ExclusionConstraint.deferrable
New in Django 3.1.

Установите этот параметр для создания откладываемого ограничения исключения. Принимаются значения Deferrable.DEFERRED или Deferrable.IMMEDIATE. Например:

from django.contrib.postgres.constraints import ExclusionConstraint
from django.contrib.postgres.fields import RangeOperators
from django.db.models import Deferrable


ExclusionConstraint(
    name='exclude_overlapping_deferred',
    expressions=[
        ('timespan', RangeOperators.OVERLAPS),
    ],
    deferrable=Deferrable.DEFERRED,
)

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

Предупреждение

Отложенные ограничения исключения могут привести к performance penalty.

Примеры

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

from django.contrib.postgres.constraints import ExclusionConstraint
from django.contrib.postgres.fields import DateTimeRangeField, RangeOperators
from django.db import models
from django.db.models import Q

class Room(models.Model):
    number = models.IntegerField()


class Reservation(models.Model):
    room = models.ForeignKey('Room', on_delete=models.CASCADE)
    timespan = DateTimeRangeField()
    cancelled = models.BooleanField(default=False)

    class Meta:
        constraints = [
            ExclusionConstraint(
                name='exclude_overlapping_reservations',
                expressions=[
                    ('timespan', RangeOperators.OVERLAPS),
                    ('room', RangeOperators.EQUAL),
                ],
                condition=Q(cancelled=False),
            ),
        ]

В случае если ваша модель определяет диапазон с использованием двух полей, вместо стандартных типов диапазонов PostgreSQL, вы должны написать выражение, которое использует эквивалентную функцию (например, TsTzRange()), и использовать разделители для поля. Чаще всего разделители будут '[)', что означает, что нижняя граница является включающей, а верхняя - исключающей. Вы можете использовать RangeBoundary, который обеспечивает отображение выражения для range boundaries. Например:

from django.contrib.postgres.constraints import ExclusionConstraint
from django.contrib.postgres.fields import (
    DateTimeRangeField,
    RangeBoundary,
    RangeOperators,
)
from django.db import models
from django.db.models import Func, Q


class TsTzRange(Func):
    function = 'TSTZRANGE'
    output_field = DateTimeRangeField()


class Reservation(models.Model):
    room = models.ForeignKey('Room', on_delete=models.CASCADE)
    start = models.DateTimeField()
    end = models.DateTimeField()
    cancelled = models.BooleanField(default=False)

    class Meta:
        constraints = [
            ExclusionConstraint(
                name='exclude_overlapping_reservations',
                expressions=(
                    (TsTzRange('start', 'end', RangeBoundary()), RangeOperators.OVERLAPS),
                    ('room', RangeOperators.EQUAL),
                ),
                condition=Q(cancelled=False),
            ),
        ]
Функции агрегации, специфичные для PostgreSQL
Поля модели, специфичные для PostgreSQL
Вернуться на верх