djangodocs.org

705 sections in Django 5.1 Search all versions →

Forward

Topic guide Making queries Related objectsOne-to-many relationships

Subsequent accesses to the foreign key on the same object instance are cached. Example: Note that the select_related() QuerySet method recursively prepopulates the cache of all one-to-many relationships ahead of time. Example:

Example

Topic guide Pagination

… you methods for accessing the items for each page: NOTE: Note that you can give Paginator a list/tuple, a Django QuerySet, > or any other object with a count() or __len__() method. When > determining the number of objects contained …

H

Index

| | | | --- | --- | | - handle() (BaseCommand method) - handle_app_config() (AppCommand method) - handle_label() (LabelCommand method) - handle_no_permission() (AccessMixin method) - handle_raw_input() (FileUploadHandler method) - handler400 (in module django.conf.urls) - handler403 (in module django.conf.urls) - …

M

Index

| | | | --- | --- | | - m (LineString attribute) - (Point attribute) - mail_admins() (in module django.core.mail) - mail_managers() (in module django.core.mail) - make_aware() (in module django.utils.timezone) - make_list - template filter - make_naive() (in module …

A lookup example

How-to How to write custom lookups

You will need to ensure that this registration happens before you try to create any querysets using it. You could place the implementation in a models.py file, or register the lookup in the ready() method of an AppConfig.

A simple example

Reference The syndication feed framework The high-level framework

This simple example, taken from a hypothetical police beat news site describes a feed of the latest five news items: To connect a URL to this feed, put an instance of the Feed object in your URLconf.

Extra instance methods

Reference Model instance reference

In addition to save(), delete(), a model object might have some of the following methods: Model.get_FOO_display() For every field that has choices set, the object will have a get_FOO_display() method, where FOO is the name of the field.

Topic guide Making queries Retrieving objects

Django offers a powerful and intuitive way to “follow” relationships in lookups, taking care of the SQL JOINs for you automatically, behind the scenes.

Topic guide Making queries Querying JSONField

As with other fields, storing None as the field’s value will store it as SQL NULL. While not recommended, it is possible to store JSON scalar null instead of SQL NULL by using Value(None, JSONField()).

Topic guide Making queries Querying JSONField

To query based on a given dictionary key, use that key as the lookup name: Multiple keys can be chained together to form a path lookup: If the key is an integer, it will be interpreted as an index transform …

… Model index reference Constraints reference Model _meta API Related objects reference Model class reference Model Meta options Model instance reference QuerySet API reference Lookup API reference Query Expressions Conditional Expressions Database Functions Paginator Paginator class Page class Exceptions Request and …

B

Index

… - buffer_with_style() (GEOSGeometry method) - build_absolute_uri() (HttpRequest method) - build_suite() (DiscoverRunner method) - built-in function - django.conf.settings.configure() - django.core.cache.utils.make_template_fragment_key() - django.core.management.call_command() - django.core.serializers.get_serializer() - django.views.decorators.cache.cache_page() - bulk_create() (in module django.db.models.query.QuerySet) - bulk_update() (in module django.db.models.query.QuerySet) - byteorder (WKBWriter attribute) |

C

Index

… attribute) - contained - field lookup type - contains - field lookup type - contains() (GEOSGeometry method) - (in module django.db.models.query.QuerySet) - (OGRGeometry method) - (PreparedGeometry method) - contains_aggregate (Expression attribute) - contains_over_clause (Expression attribute) - contains_properly - field lookup …

T

Index

| | | | --- | --- | | - TabularInline (class in django.contrib.admin) - Tan (class in django.db.models.functions) - teardown_databases() (DiscoverRunner method) - (in module django.test.utils) - teardown_test_environment() (DiscoverRunner method) - (in module django.test.utils) - tell() (HttpResponse method) - …

values_list()

Reference QuerySet API reference QuerySet APIMethods that return new QuerySets

values_list(*fields,flat=False,named=False) This is similar to values() except that instead of returning dictionaries, it returns tuples when iterated over.

extra()

Reference QuerySet API reference QuerySet APIMethods that return new QuerySets

Example: Always use params instead of embedding values directly into where because params will ensure values are quoted correctly according to your particular backend. For example, quotes will be escaped correctly.

create()

Reference QuerySet API reference QuerySet APIMethods that do not return QuerySets

create(**kwargs) acreate(**kwargs) Asynchronous version: acreate() A convenience method for creating an object and saving it all in one step. Thus: and: are equivalent.

bulk_create()

Reference QuerySet API reference QuerySet APIMethods that do not return QuerySets

bulk_create(objs,batch_size=None,ignore_conflicts=False,update_conflicts=False,update_fields=None,unique_fields=None) abulk_create(objs,batch_size=None,ignore_conflicts=False,update_conflicts=False,update_fields=None,unique_fields=None) Asynchronous version: abulk_create() This method inserts the provided list of objects into the database in an efficient manner (generally only 1 query, no matter how many objects there are), and returns created objects as a list, in the …

With server-side cursors

Reference QuerySet API reference QuerySet APIMethods that do not return QuerySetsiterator()

Oracle and PostgreSQL use server-side cursors to stream results from the database without loading the entire result set into memory. The Oracle database driver always uses server-side cursors.

exact

Reference QuerySet API reference QuerySet APIField lookups

Exact match. If the value provided for comparison is None, it will be interpreted as an SQL NULL (see isnull for more details).