Class RelatedField

django.db.models.fields.related.RelatedField

Base class that all relational fields inherit from.

Declaration

class RelatedField(FieldCacheMixin, Field)

source link

Documentation

Methods

▶ def check(self, **kwargs) override
source link
This method overrides django.db.models.fields.Field.check.
Overrides
This method is overriden in:
- django.db.models.fields.related.ForeignObject
- django.db.models.fields.related.ManyToManyField
▶ def contribute_to_class(self, cls, name, private_only=False, **kwargs) override
inherited doc Register the field with the model class it belongs to.
source link
This method overrides django.db.models.fields.Field.contribute_to_class.
```
If private_only is True, create a separate instance of this field
for every subclass of cls, even if cls is not an abstract model.
```
Overrides
This method is overriden in:
- django.db.models.fields.related.ForeignObject
- django.db.models.fields.related.ManyToManyField
▶ def db_type(self, connection) override
inherited doc Return the database column data type for this field, for the provided connection.
source link
This method overrides django.db.models.fields.Field.db_type.
Overrides
This method is overriden in:
- django.db.models.fields.related.ForeignKey
- django.db.models.fields.related.ManyToManyField

▶ def deconstruct(self) override

inherited doc Return enough information to recreate the field as a 4-tuple:

source link

This method overrides django.db.models.fields.Field.deconstruct.

* The name of the field on the model, if contribute_to_class() has
   been run.
 * The import path of the field, including the class:e.g.
   django.db.models.IntegerField This should be the most portable
   version, so less specific may be better.
 * A list of positional arguments.
 * A dict of keyword arguments.

Note that the positional or keyword arguments must contain values of
the following types (including inner values of collection types):

 * None, bool, str, int, float, complex, set, frozenset, list, tuple,
   dict
 * UUID
 * datetime.datetime (naive), datetime.date
 * top-level classes, top-level functions - will be referenced by their
   full import path
 * Storage instances - these have their own deconstruct() method

This is because the values here must be serialized into a text format
(possibly new Python code, possibly JSON) and these are the only types
with encoding handlers defined.

There's no need to return the exact way the field was instantiated this
time, just ensure that the resulting field is the same - prefer keyword
arguments over positional ones, and omit parameters with their default
values.

Overrides

This method is overriden in:

▷ def do_related_class(self, other, cls)
source link
▶ def formfield(self, **kwargs) override
Pass ``limit_choices_to`` to the field being constructed.
source link
This method overrides django.db.models.fields.Field.formfield.
```
Only passes it if there is a type that supports related fields.
This is a similar strategy used to pass the ``queryset`` to the field
being constructed.
```
Overrides
This method is overriden in:
- django.db.models.fields.related.ForeignKey
- django.db.models.fields.related.ManyToManyField
▶ def get_cache_name(self) override
source link
This method overrides django.db.models.fields.mixins.FieldCacheMixin.get_cache_name.

▶ def get_forward_related_filter(self, obj)

Return the keyword arguments that when supplied to

source link

self.model.object.filter(), would select all instances related through
this field to the remote obj. This is used to build the querysets
returned by related descriptors. obj is an instance of
self.related_field.model.

▶ def get_limit_choices_to(self)
Return ``limit_choices_to`` for this model field.
source link
```
If it is a callable, it will be invoked and the result will be
returned.
```

▶ def get_reverse_related_filter(self, obj)

Complement to get_forward_related_filter(). Return the keyword

source link

arguments that when passed to self.related_field.model.object.filter()
select all instances of self.related_field.model related through
this field to obj. obj is an instance of self.model.

▷ def related_model(self) @cached_property
@cached_property
def related_model(self)
source link
▷ def related_query_name(self)
Define the name that can be used to identify this related object in a table-spanning query.
source link
▶ def set_attributes_from_rel(self)
source link
Overrides
This method is overriden in:
- django.contrib.contenttypes.fields.GenericRelation
- django.db.models.fields.related.ManyToManyField
▷ def swappable_setting(self) @property
Get the setting that this is powered from for swapping, or None if it's not swapped in / marked with swappable=False.
@property
def swappable_setting(self)
source link
▶ def target_field(self) @property
When filtering against this relation, return the field on the remote model against which the filtering should happen.
@property
def target_field(self)
source link
Overrides
This method is overriden in:
- django.db.models.fields.related.ForeignKey

Inherited methods

Methods inherited from django.db.models.fields.mixins.FieldCacheMixin:
delete_cached_value, get_cached_value, is_cached, set_cached_value
Methods inherited from django.db.models.fields.Field:
__copy__, __deepcopy__, __eq__, __hash__, __init__, __lt__, __reduce__, __repr__, __str__, cached_col, cast_db_type, clean, clone, db_check, db_parameters, db_returning, db_tablespace, db_type_parameters, db_type_suffix, get_attname, get_attname_column, get_choices, get_col, get_db_converters, get_db_prep_save, get_db_prep_value, get_default, get_filter_kwargs_for_object, get_internal_type, get_pk_value_on_save, get_prep_value, has_default, pre_save, rel_db_type, run_validators, save_form_data, select_format, set_attributes_from_name, to_python, unique, validate, validators, value_from_object, value_to_string
Methods inherited from django.db.models.query_utils.RegisterLookupMixin:
get_lookup, get_lookups, get_transform, merge_dicts, register_lookup

Django

Class RelatedField

Declaration

Documentation

Methods

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Inherited methods

Subclasses