Changeset 6303

Timestamp:

09/15/07 13:31:50 (1 year ago)

Author:

adrian

Message:

Fixed #5275 -- Documented QuerySet?.iterator(). Thanks, ubernostrum

Files:

• django/trunk/docs/db-api.txt (modified) (1 diff)

django/trunk/docs/db-api.txt

@@ -952 +952 @@
-If you pass ``in_bulk()`` an empty list, you'll get an empty dictionary.
-
+``iterator()``
+~~~~~~~~~~~~
+
+Evaluates the ``QuerySet`` (by performing the query) and returns an
+`iterator`_ over the results. A ``QuerySet`` typically reads all of
+its results and instantiates all of the corresponding objects the
+first time you access it; ``iterator()`` will instead read results and
+instantiate objects in discrete chunks, yielding them one at a
+time. For a ``QuerySet`` which returns a large number of objects, this
+often results in better performance and a significant reduction in
+memory use.
+
+Note that using ``iterator()`` on a ``QuerySet`` which has already
+been evaluated will force it to evaluate again, repeating the query.
+
+.. _iterator: http://www.python.org/dev/peps/pep-0234/
+
-``latest(field_name=None)``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~