Module models

django.db.models

source link

Re-exported Classes

class Case
An SQL searched CASE expression:
[django.db.models.expressions.Case]
class Exists
[django.db.models.expressions.Exists]
class Expression
An expression that can be combined with other expressions.
[django.db.models.expressions.Expression]
class ExpressionList
An expression containing multiple expressions. Can be used to provide a list of expressions as an argument to another expression, like an ordering clause.
[django.db.models.expressions.ExpressionList]
class ExpressionWrapper
An expression that can wrap another expression so that it can provide extra context to the inner expression, such as the output_field.
[django.db.models.expressions.ExpressionWrapper]
class F
An object capable of resolving references to existing query objects.
[django.db.models.expressions.F]
class FileField
[django.db.models.fields.files.FileField]
class FilteredRelation
Specify custom filtering in the ON clause of SQL joins.
[django.db.models.query_utils.FilteredRelation]
class ForeignKey
Provide a many-to-one relation by adding a column to the local model to hold the remote value.
[django.db.models.fields.related.ForeignKey]
class ForeignObject
Abstraction of the ForeignKey relation to support multi-column relations.
[django.db.models.fields.related.ForeignObject]
class ForeignObjectRel
Used by ForeignObject to store information about the relation.
[django.db.models.fields.reverse_related.ForeignObjectRel]
class Func
An SQL function call.
[django.db.models.expressions.Func]
class ImageField
[django.db.models.fields.files.ImageField]
class JSONField
[django.db.models.fields.json.JSONField]
class Lookup
[django.db.models.lookups.Lookup]
class Manager
[django.db.models.manager.Manager]
class ManyToManyField
Provide a many-to-many relation by using an intermediary model that holds two ForeignKey fields pointed at the two sides of the relation.
[django.db.models.fields.related.ManyToManyField]
class ManyToManyRel
Used by ManyToManyField to store information about the relation.
[django.db.models.fields.reverse_related.ManyToManyRel]
class ManyToOneRel
Used by the ForeignKey field to store information about the relation.
[django.db.models.fields.reverse_related.ManyToOneRel]
class Model
[django.db.models.base.Model]
class OneToOneField
A OneToOneField is essentially the same as a ForeignKey, with the exception
[django.db.models.fields.related.OneToOneField]
class OneToOneRel
Used by OneToOneField to store information about the relation.
[django.db.models.fields.reverse_related.OneToOneRel]
class OrderBy
[django.db.models.expressions.OrderBy]
class OrderWrt
A proxy for the _order database field that is used when Meta.order_with_respect_to is specified.
[django.db.models.fields.proxy.OrderWrt]
class OuterRef
[django.db.models.expressions.OuterRef]
class Prefetch
[django.db.models.query.Prefetch]
class ProtectedError
[django.db.models.deletion.ProtectedError]
class Q
Encapsulate filters as objects that can then be combined logically (using `&` and `|`).
[django.db.models.query_utils.Q]
class QuerySet
Represent a lazy database lookup for a set of objects.
[django.db.models.query.QuerySet]
class RestrictedError
[django.db.models.deletion.RestrictedError]
class RowRange
[django.db.models.expressions.RowRange]
class Subquery
An explicit subquery. It may contain OuterRef() references to the outer query which will be resolved when it is applied to that query.
[django.db.models.expressions.Subquery]
class Transform
RegisterLookupMixin() is first so that get_lookup() and get_transform() first examine self and then check output_field.
[django.db.models.lookups.Transform]
class Value
Represent a wrapped value as a node within an expression.
[django.db.models.expressions.Value]
class ValueRange
[django.db.models.expressions.ValueRange]
class When
[django.db.models.expressions.When]
class Window
[django.db.models.expressions.Window]
class WindowFrame
Model the frame clause in window expressions. There are two types of frame
[django.db.models.expressions.WindowFrame]

Re-exported Functions

def CASCADE(collector, field, sub_objs, using)
[django.db.models.deletion.CASCADE]
def DO_NOTHING(collector, field, sub_objs, using)
[django.db.models.deletion.DO_NOTHING]
def PROTECT(collector, field, sub_objs, using)
[django.db.models.deletion.PROTECT]
def RESTRICT(collector, field, sub_objs, using)
[django.db.models.deletion.RESTRICT]
def SET(value)
[django.db.models.deletion.SET]
def SET_DEFAULT(collector, field, sub_objs, using)
[django.db.models.deletion.SET_DEFAULT]
def SET_NULL(collector, field, sub_objs, using)
[django.db.models.deletion.SET_NULL]
def prefetch_related_objects(model_instances, *related_lookups)
Populate prefetched object caches for a list of model instances based on the lookups/Prefetch instances given.
[django.db.models.query.prefetch_related_objects]

Submodules

Module django.db.models.aggregates
Classes to represent the definitions of aggregate functions.
Module django.db.models.base
Module django.db.models.constants
Constants used across the ORM in general.
Module django.db.models.constraints
Module django.db.models.deletion
Module django.db.models.enums
Module django.db.models.expressions
Module django.db.models.fields
Module django.db.models.functions
Module django.db.models.indexes
Module django.db.models.lookups
Module django.db.models.manager
Module django.db.models.options
Module django.db.models.query
The main QuerySet implementation. This provides the public API for the ORM.
Module django.db.models.query_utils
Various data structures used in query construction.
Module django.db.models.signals
Module django.db.models.sql
Module django.db.models.utils

Django

Module models

Re-exported Classes

Re-exported Functions

Submodules