summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNg Zhi An <ngzhian@gmail.com>2015-01-11 20:02:33 +0000
committerTim Graham <timograham@gmail.com>2015-01-12 11:35:20 -0500
commit8f5d6c77b6bbe0390b683cea649de6ad24d80fef (patch)
treea752715b34f2a74d02cd67ec66dfb5b9679cb417 /docs
parent58833f519797e15ae3cb39b1613e5f7e09c96952 (diff)
Fixed #23878 -- Moved Query and Prefetch documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/index.txt1
-rw-r--r--docs/ref/models/index.txt1
-rw-r--r--docs/ref/models/queries.txt51
-rw-r--r--docs/ref/models/querysets.txt55
4 files changed, 55 insertions, 53 deletions
diff --git a/docs/index.txt b/docs/index.txt
index f390d06dd2..5204f00085 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -67,7 +67,6 @@ manipulating the data of your Web application. Learn more about it below:
* **QuerySets:**
:doc:`Executing queries <topics/db/queries>` |
:doc:`QuerySet method reference <ref/models/querysets>` |
- :doc:`Query-related classes <ref/models/queries>` |
:doc:`Lookup expressions <ref/models/lookups>`
* **Model instances:**
diff --git a/docs/ref/models/index.txt b/docs/ref/models/index.txt
index 284743e7d0..c860ee2e04 100644
--- a/docs/ref/models/index.txt
+++ b/docs/ref/models/index.txt
@@ -14,7 +14,6 @@ Model API reference. For introductory material, see :doc:`/topics/db/models`.
options
instances
querysets
- queries
lookups
expressions
database-functions
diff --git a/docs/ref/models/queries.txt b/docs/ref/models/queries.txt
deleted file mode 100644
index 283983aef3..0000000000
--- a/docs/ref/models/queries.txt
+++ /dev/null
@@ -1,51 +0,0 @@
-=====================
-Query-related classes
-=====================
-
-.. currentmodule:: django.db.models
-
-This document provides reference material for query-related tools not
-documented elsewhere.
-
-``Q()`` objects
-===============
-
-.. class:: Q
-
-A ``Q()`` object, like an :class:`~django.db.models.F` object, encapsulates a
-SQL expression in a Python object that can be used in database-related
-operations.
-
-In general, ``Q() objects`` make it possible to define and reuse conditions.
-This permits the :ref:`construction of complex database queries
-<complex-lookups-with-q>` using ``|`` (``OR``) and ``&`` (``AND``) operators;
-in particular, it is not otherwise possible to use ``OR`` in ``QuerySets``.
-
-``Prefetch()`` objects
-======================
-
-.. versionadded:: 1.7
-
-.. class:: Prefetch(lookup, queryset=None, to_attr=None)
-
-The ``Prefetch()`` object can be used to control the operation of
-:meth:`~django.db.models.query.QuerySet.prefetch_related()`.
-
-The ``lookup`` argument describes the relations to follow and works the same
-as the string based lookups passed to
-:meth:`~django.db.models.query.QuerySet.prefetch_related()`.
-
-The ``queryset`` argument supplies a base ``QuerySet`` for the given lookup.
-This is useful to further filter down the prefetch operation, or to call
-:meth:`~django.db.models.query.QuerySet.select_related()` from the prefetched
-relation, hence reducing the number of queries even further.
-
-The ``to_attr`` argument sets the result of the prefetch operation to a custom
-attribute.
-
-.. note::
-
- When using ``to_attr`` the prefetched result is stored in a list.
- This can provide a significant speed improvement over traditional
- ``prefetch_related`` calls which store the cached result within a
- ``QuerySet`` instance.
diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt
index 6784f352ed..397eea0782 100644
--- a/docs/ref/models/querysets.txt
+++ b/docs/ref/models/querysets.txt
@@ -180,6 +180,9 @@ The lookup parameters (``**kwargs``) should be in the format described in
`Field lookups`_ below. Multiple parameters are joined via ``AND`` in the
underlying SQL statement.
+If you need to execute more complex queries (for example, queries with ``OR`` statements),
+you can use :class:`Q objects <django.db.models.Q>`.
+
exclude
~~~~~~~
@@ -215,6 +218,9 @@ In SQL terms, that evaluates to::
Note the second example is more restrictive.
+If you need to execute more complex queries (for example, queries with ``OR`` statements),
+you can use :class:`Q objects <django.db.models.Q>`.
+
annotate
~~~~~~~~
@@ -2843,3 +2849,52 @@ Variance
extension.
.. _SQLite documentation: http://www.sqlite.org/contrib
+
+Query-related classes
+=====================
+
+This section provides reference material for query-related tools not documented
+elsewhere.
+
+``Q()`` objects
+---------------
+
+.. class:: Q
+
+A ``Q()`` object, like an :class:`~django.db.models.F` object, encapsulates a
+SQL expression in a Python object that can be used in database-related
+operations.
+
+In general, ``Q() objects`` make it possible to define and reuse conditions.
+This permits the :ref:`construction of complex database queries
+<complex-lookups-with-q>` using ``|`` (``OR``) and ``&`` (``AND``) operators;
+in particular, it is not otherwise possible to use ``OR`` in ``QuerySets``.
+
+``Prefetch()`` objects
+----------------------
+
+.. versionadded:: 1.7
+
+.. class:: Prefetch(lookup, queryset=None, to_attr=None)
+
+The ``Prefetch()`` object can be used to control the operation of
+:meth:`~django.db.models.query.QuerySet.prefetch_related()`.
+
+The ``lookup`` argument describes the relations to follow and works the same
+as the string based lookups passed to
+:meth:`~django.db.models.query.QuerySet.prefetch_related()`.
+
+The ``queryset`` argument supplies a base ``QuerySet`` for the given lookup.
+This is useful to further filter down the prefetch operation, or to call
+:meth:`~django.db.models.query.QuerySet.select_related()` from the prefetched
+relation, hence reducing the number of queries even further.
+
+The ``to_attr`` argument sets the result of the prefetch operation to a custom
+attribute.
+
+.. note::
+
+ When using ``to_attr`` the prefetched result is stored in a list. This can
+ provide a significant speed improvement over traditional
+ ``prefetch_related`` calls which store the cached result within a
+ ``QuerySet`` instance.