Справочник по связанным объектам

class RelatedManager

«Связанный менеджер» — это менеджер, используемый в контексте отношений «один ко многим» или «многие ко многим». Это происходит в двух случаях:

• «Другая сторона» отношения ForeignKey. То есть:

  from django.db import models
  
  class Blog(models.Model):
      # ...
      pass
  
  class Entry(models.Model):
      blog = models.ForeignKey(Blog, on_delete=models.CASCADE, null=True)
  

  В приведенном выше примере методы, описанные ниже, будут доступны в менеджере blog.entry_set.

• Обе стороны отношения ManyToManyField:

  class Topping(models.Model):
      # ...
      pass
  
  class Pizza(models.Model):
      toppings = models.ManyToManyField(Topping)
  

  В этом примере методы ниже будут доступны как в topping.pizza_set, так и в pizza.toppings.

add(*objs, bulk=True, through_defaults=None)

Добавляет указанные объекты модели в набор связанных объектов.

Пример:

>>> b = Blog.objects.get(id=1)
>>> e = Entry.objects.get(id=234)
>>> b.entry_set.add(e) # Associates Entry e with Blog b.

В приведенном выше примере, в случае отношения ForeignKey, используется QuerySet.update() для выполнения обновления. Для этого объекты должны быть уже сохранены.

Вы можете использовать аргумент bulk=False, чтобы связанный менеджер выполнил обновление, вызвав e.save().

Однако, использование add() с отношением «многие ко многим» не вызовет никаких методов save() (аргумент bulk не существует), а вместо этого создаст отношения, используя QuerySet.bulk_create(). Если вам нужно выполнить определённую логику при создании связи, подпишитесь на сигнал m2m_changed, который сработает для действий pre_add и post_add.

Использование add() для уже существующего отношения не будет дублировать связь, но всё равно сработают сигналы.

Для отношений «многие ко многим» add() принимает в качестве аргумента *objs либо экземпляры модели, либо значения полей, обычно первичные ключи.

Используйте аргумент through_defaults для указания значений для нового(их) экземпляра(ов) промежуточной модели, если необходимо. В словаре through_defaults вы можете использовать вызываемые объекты в качестве значений; они будут вычислены один раз перед созданием любого промежуточного объекта(ов).

create(through_defaults=None, **kwargs)

Создаёт новый объект, сохраняет его и помещает в набор связанных объектов. Возвращает созданный объект:

>>> b = Blog.objects.get(id=1)
>>> e = b.entry_set.create(
...     headline='Hello',
...     body_text='Hi',
...     pub_date=datetime.date(2005, 1, 1)
... )

# No need to call e.save() at this point -- it's already been saved.

Это эквивалентно (но проще), чем:

>>> b = Blog.objects.get(id=1)
>>> e = Entry(
...     blog=b,
...     headline='Hello',
...     body_text='Hi',
...     pub_date=datetime.date(2005, 1, 1)
... )
>>> e.save(force_insert=True)

Обратите внимание, что нет необходимости указывать ключевой аргумент модели, определяющий отношение. В приведенном выше примере мы не передаём параметр blog в create(). Django определяет, что поле Entry нового объекта blog должно быть установлено в b.

Используйте аргумент through_defaults для указания значений для нового экземпляра промежуточной модели, если необходимо. В словаре through_defaults вы можете использовать вызываемые объекты в качестве значений.

remove(*objs, bulk=True)

Удаляет указанные объекты модели из набора связанных объектов:

>>> b = Blog.objects.get(id=1)
>>> e = Entry.objects.get(id=234)
>>> b.entry_set.remove(e) # Disassociates Entry e from Blog b.

Аналогично add(), в примере выше вызывается e.save() для выполнения обновления. Однако, использование remove() с отношением «многие ко многим» удалит отношения, используя QuerySet.delete(), что означает, что методы модели save() не вызываются; подпишитесь на сигнал m2m_changed, если хотите выполнить пользовательский код при удалении связи.

Для отношений «многие ко многим» remove() принимает в качестве аргумента *objs либо экземпляры модели, либо значения полей, обычно первичные ключи.

Для объектов ForeignKey, этот метод существует только, если null=True. Если связанное поле не может быть установлено в None (NULL), то объект не может быть удален из связи без добавления в другую. В приведенном выше примере удаление e из b.entry_set() эквивалентно e.blog = None, и поскольку поле blog ForeignKey не имеет null=True, это некорректно.

Для объектов ForeignKey, этот метод принимает аргумент bulk для управления выполнением операции. Если True (по умолчанию), используется QuerySet.update(). Если bulk=False, вместо этого вызывается метод save() каждого экземпляра модели. Это срабатывает для сигналов pre_save и post_save и происходит за счёт производительности.

Для отношений «многие ко многим» аргумент bulk не существует.

clear(bulk=True)

Удаляет все объекты из набора связанных объектов:

>>> b = Blog.objects.get(id=1)
>>> b.entry_set.clear()

Обратите внимание, что это не удаляет связанные объекты — это просто отключает их.

Так же, как и remove(), clear() доступно только для ForeignKey, где null=True, и также принимает аргумент bulk.

Для отношений «многие ко многим» аргумент bulk не существует.

set(objs, bulk=True, clear=False, through_defaults=None)

Заменяет набор связанных объектов:

>>> new_list = [obj1, obj2, obj3]
>>> e.related_set.set(new_list)

Этот метод принимает аргумент clear для управления выполнением операции. Если False (по умолчанию), элементы, отсутствующие в новом наборе, удаляются с помощью remove(), и добавляются только новые. Если clear=True, вместо этого вызывается метод clear() и весь набор добавляется сразу.

Для объектов ForeignKey, аргумент bulk передаётся в add() и remove().

Для отношений «многие ко многим» аргумент bulk не существует.

Обратите внимание, что, поскольку set() — это составная операция, она подвержена конкурентным условиям. Например, новые объекты могут быть добавлены в базу данных между вызовом clear() и вызовом add().

Для отношений «многие ко многим» set() принимает список либо экземпляров модели, либо значений полей, обычно первичных ключей, в качестве аргумента objs.

Используйте аргумент through_defaults для указания значений для нового(их) экземпляра(ов) промежуточной модели, если необходимо. В словаре through_defaults вы можете использовать вызываемые объекты в качестве значений; они будут вычислены один раз перед созданием любого промежуточного объекта(ов).

Примечание

Обратите внимание, что add(), create(), remove(), clear(), и set() сразу применяют изменения в базе данных для всех типов связанных полей. Другими словами, нет необходимости вызывать save() на обоих концах отношения.

Если вы используете prefetch_related(), методы add(), remove(), clear(), и set() очищают кэш предварительной выборки.