Class Collector

Declaration

Methods

• ▶ def __init__(self, using)

  source link

  Overrides

  This method is overriden in:

  • django.contrib.admin.utils.NestedObjects
• ▶ def add(self, objs, source=None, nullable=False, reverse_dependency=False)

  Add 'objs' to the collection of objects to be deleted. If the call is the result of a cascade, 'source' should be the model that caused it, and 'nullable' should be set to True if the relation can be null.

  source link

  Return a list of all objects that were not already collected.

• ▷ def add_dependency(self, model, dependency, reverse_dependency=False)

  source link
• ▷ def add_field_update(self, field, value, objs)

  Schedule a field update. 'objs' must be a homogeneous iterable collection of model instances (e.g. a QuerySet).

  source link
• ▷ def add_restricted_objects(self, field, objs)

  source link
• ▶ def can_fast_delete(self, objs, from_field=None)

  Determine if the objects in the given queryset-like or single object can be fast-deleted. This can be done if there are no cascades, no parents and no signal listeners for the object class.

  source link

  The 'from_field' tells where we are coming from - we need this to
  determine if the objects are in fact to be deleted. Allow also
  skipping parent -> child -> parent chain preventing fast delete of
  the child.

  Overrides

  This method is overriden in:

  • django.contrib.admin.utils.NestedObjects
  • django.contrib.contenttypes.management.commands.remove_stale_contenttypes.NoFastDeleteCollector
• ▷ def clear_restricted_objects_from_queryset(self, model, qs)

  source link
• ▷ def clear_restricted_objects_from_set(self, model, objs)

  source link
• ▶ def collect(self, objs, source=None, nullable=False, collect_related=True, ...)

  Add 'objs' to the collection of objects to be deleted as well as all

  def collect(

  self,

  objs,

  source=None,

  nullable=False,

  collect_related=True,

  source_attr=None,

  reverse_dependency=False,

  keep_parents=False,

  fail_on_restricted=True,

  )

  source link

  parent instances.  'objs' must be a homogeneous iterable collection of
  model instances (e.g. a QuerySet).  If 'collect_related' is True,
  related objects will be handled by their respective on_delete handler.
  
  If the call is the result of a cascade, 'source' should be the model
  that caused it and 'nullable' should be set to True, if the relation
  can be null.
  
  If 'reverse_dependency' is True, 'source' will be deleted before the
  current model, rather than after. (Needed for cascading to parent
  models, the one case in which the cascade follows the forwards
  direction of an FK rather than the reverse direction.)
  
  If 'keep_parents' is True, data of parent model's will be not deleted.
  
  If 'fail_on_restricted' is False, error won't be raised even if it's
  prohibited to delete such objects due to RESTRICT, that defers
  restricted object checking in recursive calls where the top-level call
  may need to collect more objects to determine whether restricted ones
  can be deleted.

  Overrides

  This method is overriden in:

  • django.contrib.admin.utils.NestedObjects
• ▷ def delete(self)

  source link
• ▷ def get_del_batches(self, objs, fields)

  Return the objs in suitably sized batches for the used connection.

  source link
• ▷ def instances_with_model(self)

  source link
• ▶ def related_objects(self, related_model, related_fields, objs)

  Get a QuerySet of the related model to objs via related fields.

  source link

  Overrides

  This method is overriden in:

  • django.contrib.admin.utils.NestedObjects
• ▷ def sort(self)

  source link

Subclasses

• django.contrib.admin.utils.NestedObjects
• django.contrib.contenttypes.management.commands.remove_stale_contenttypes.NoFastDeleteCollector

Reexports

• Imported in django.contrib.admin.utils.
• Imported in django.contrib.contenttypes.management.commands.remove_stale_contenttypes.
• Imported in django.db.models.base.
• Imported in django.db.models.query.

Generated by nedoc v0.9 at 2020-12-29 14:04