Ссылка на связанные объекты

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)

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

Асинхронная версия: aadd

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

Пример:

>>> 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)

acreate(through_defaults=None, **kwargs)

Асинхронная версия: acreate

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

>>> 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)

aremove(*objs, bulk=True)

Асинхронная версия: aremove

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

>>> 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)

aclear(bulk=True)

Асинхронная версия: aclear

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

>>> 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)

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

Асинхронная версия: aset

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

>>> 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(), aadd(), create(), acreate(), remove(), aremove(), clear(), aclear(), set(), и aset() все изменяют базу данных непосредственно для всех типов связанных полей. Другими словами, нет необходимости вызывать save()/asave() на любой стороне отношения.

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