From d7086fc4a3eea94fbd5b6360ddbeb8b32d8e280d Mon Sep 17 00:00:00 2001 From: Harry Marr Date: Mon, 8 Mar 2010 22:23:40 +0000 Subject: [PATCH] Added rewind behaviour and BinaryField to docs --- docs/apireference.rst | 2 ++ docs/guide/querying.rst | 7 +++++++ 2 files changed, 9 insertions(+) diff --git a/docs/apireference.rst b/docs/apireference.rst index ec78efa0..2433ddfe 100644 --- a/docs/apireference.rst +++ b/docs/apireference.rst @@ -54,6 +54,8 @@ Fields .. autoclass:: mongoengine.ListField +.. autoclass:: mongoengine.BinaryField + .. autoclass:: mongoengine.ObjectIdField .. autoclass:: mongoengine.ReferenceField diff --git a/docs/guide/querying.rst b/docs/guide/querying.rst index 6b14b12e..ddab385e 100644 --- a/docs/guide/querying.rst +++ b/docs/guide/querying.rst @@ -13,6 +13,13 @@ fetch documents from the database:: for user in User.objects: print user.name +.. note:: + Once the iteration finishes (when :class:`StopIteration` is raised), + :meth:`~mongoengine.queryset.QuerySet.rewind` will be called so that the + :class:`~mongoengine.queryset.QuerySet` may be iterated over again. The + results of the first iteration are *not* cached, so the database will be hit + each time the :class:`~mongoengine.queryset.QuerySet` is iterated over. + Filtering queries ================= The query may be filtered by calling the