Added note to item_frequencies method.

Current implementation is relatively simple, for complex schemas
the user will have to write their own map reduce.
This commit is contained in:
Ross Lawley 2011-06-15 14:55:38 +01:00
parent 5411cc5573
commit 967e72723b

View File

@ -1400,6 +1400,12 @@ class QuerySet(object):
the whole queried set of documents, and their corresponding frequency. the whole queried set of documents, and their corresponding frequency.
This is useful for generating tag clouds, or searching documents. This is useful for generating tag clouds, or searching documents.
.. note::
Can only do direct simple mappings and cannot map across
:class:`~mongoengine.ReferenceField` or
:class:`~mongoengine.GenericReferenceField` for more complex
counting a manual map reduce call would is required.
If the field is a :class:`~mongoengine.ListField`, the items within If the field is a :class:`~mongoengine.ListField`, the items within
each list will be counted individually. each list will be counted individually.