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

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, и они будут вычислены один раз перед созданием любых промежуточных экземпляров.

Изменено в Django 4.2:

aadd() метод был добавлен.

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 не существует.

Изменено в Django 4.2:

aremove() метод был добавлен.

clear(bulk=True)

aclear(bulk=True)

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

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

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

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

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

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

Изменено в Django 4.2:

aclear() метод был добавлен.

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, и они будут вычислены один раз перед созданием любых промежуточных экземпляров.

Изменено в Django 4.2:

aset() метод был добавлен.

Примечание

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

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