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

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

Для объектов 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)

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

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

Примечание

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

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

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