Составные первичные ключи

Переход на составной первичный ключ

Django не поддерживает переход на составной первичный ключ или отказ от него после создания таблицы. Также не поддерживается добавление или удаление полей составного первичного ключа.

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

После создания составного первичного ключа добавьте в модель поле CompositePrimaryKey. Это позволит Django распознать составной первичный ключ и правильно его обрабатывать.

Операции миграции (например, AddField, AlterField) над полями первичного ключа не поддерживаются, однако makemigrations по-прежнему будет обнаруживать изменения.

Во избежание ошибок рекомендуется применять такие миграции с помощью --fake.

В качестве альтернативы можно использовать SeparateDatabaseAndState, чтобы выполнить специфичные для серверной части миграции и созданные Django миграции в рамках одной операции.

Составные первичные ключи и связи

Поля связей, включая универсальные связи, не поддерживают составные первичные ключи.

Например, для модели OrderLineItem не поддерживается следующее:

class Foo(models.Model):
    item = models.ForeignKey(OrderLineItem, on_delete=models.CASCADE)

Это связано с тем, что ForeignKey в настоящее время не может ссылаться на модели с составными первичными ключами.

Чтобы обойти это ограничение, в качестве альтернативы можно использовать ForeignObject:

class Foo(models.Model):
    item_order_id = models.CharField(max_length=20)
    item_product_id = models.IntegerField()
    item = models.ForeignObject(
        OrderLineItem,
        on_delete=models.CASCADE,
        from_fields=("item_order_id", "item_product_id"),
        to_fields=("order_id", "product_id"),
    )

ForeignObject во многом похож на ForeignKey, но не создаёт в базе данных столбцов (например, item_id), ограничений внешнего ключа или индексов, а аргумент on_delete игнорируется.

Составные первичные ключи и функции базы данных

Многие функции базы данных принимают только одно выражение.

MAX("order_id")  -- OK
MAX("product_id", "order_id")  -- ERROR

В таких случаях передача ссылки на составной первичный ключ вызывает исключение ValueError, поскольку такой ключ состоит из нескольких выражений столбцов. Исключение сделано для Count.

Max("order_id")  # OK
Max("pk")  # ValueError
Count("pk")  # OK

Составные первичные ключи в формах

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

Рассмотрим, например, следующую форму:

class OrderLineItemForm(forms.ModelForm):
    class Meta:
        model = OrderLineItem
        fields = "__all__"

В этой форме нет поля формы pk для составного первичного ключа:

>>> OrderLineItemForm()
<OrderLineItemForm bound=False, valid=Unknown, fields=(product;order;quantity)>

Если задать составное поле первичного ключа pk как поле формы, будет вызвана ошибка о неизвестном поле FieldError.

Составные первичные ключи при проверке моделей

Поскольку pk — это только виртуальное поле, указание pk в качестве имени поля в аргументе exclude метода Model.clean_fields() не даст никакого эффекта. Чтобы исключить поля составного первичного ключа из проверки модели, укажите каждое поле отдельно. Метод Model.validate_unique() по-прежнему можно вызвать с аргументом exclude={"pk"}, чтобы пропустить проверки уникальности.

Разработка приложений с поддержкой составных первичных ключей

До появления составных первичных ключей единственное поле, составляющее первичный ключ модели, можно было найти, проверив атрибут primary key у её полей:

>>> pk_field = None
>>> for field in Product._meta.get_fields():
...     if field.primary_key:
...         pk_field = field
...         break
...
>>> pk_field
<django.db.models.fields.AutoField: id>

Теперь, когда первичный ключ может состоять из нескольких полей, на атрибут primary key больше нельзя полагаться при определении полей, входящих в состав первичного ключа, поскольку для них он будет иметь значение False. Это необходимо, чтобы сохранить инвариант: не более одного поля модели может иметь значение True для этого атрибута:

>>> pk_fields = []
>>> for field in OrderLineItem._meta.get_fields():
...     if field.primary_key:
...         pk_fields.append(field)
...
>>> pk_fields
[]

Чтобы создавать код приложения, корректно обрабатывающий составные первичные ключи, следует использовать атрибут _meta.pk_fields:

>>> Product._meta.pk_fields
[<django.db.models.fields.AutoField: id>]
>>> OrderLineItem._meta.pk_fields
[
    <django.db.models.fields.ForeignKey: product>,
    <django.db.models.fields.ForeignKey: order>
]