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

class RelatedManager

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

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

  from django.db import models
  
  class Reporter(models.Model):
      # ...
      pass
  
  class Article(models.Model):
      reporter = models.ForeignKey(Reporter, on_delete=models.CASCADE)
  

  В приведенном выше примере методы ниже будут доступны для менеджера reporter.article_set.

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

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

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

add(*objs, bulk=True)

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

Пример:

>>> 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() для уже существующего отношения не продублирует его, но все равно запустит сигналы.

create(**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.

remove(*objs)

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

>>> 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, если вы хотите выполнить пользовательский код при удалении отношения.

Для объектов 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 и происходит за счет производительности.

clear()

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

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

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

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

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

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

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

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

Аргумент bulk передаётся в add().

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

Примечание

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

Также, если вы используете промежуточную модель для отношения «многие ко многим», то методы add(), create(), remove(), и set() отключены.

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

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

Было добавлено очищение кэша предварительной выборки, описанное выше.