pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated map/reduce documentation

Browse Source
This commit is contained in:
blackbrrr 2010-02-12 16:07:44 -06:00
parent a4c5fa57e0
commit 008a62e4e9
2 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
mongoengine/queryset.py
View File

@ -387,36 +387,29 @@ class QuerySet(object):
and ordering. While ``map_reduce`` respects ``QuerySet`` chaining,
it must be the last call made, as it does not return a maleable
``QuerySet``.
Example: map/reduce operation is given a ``QuerySet``
of all posts by "mattdennewitz", ordered by most recent "pub_date". ::
map_f = function() { ... }
reduce_f = function(key, values) { ... }
posts = BlogPost(author="mattdennewitz").order_by("-pub_date")
tag_counts = posts.map_reduce(map_f, reduce_f)
See the :meth:`~mongoengine.tests.QuerySetTest.test_map_reduce_simple`
unit test for more usage examples.
See the :meth:`~mongoengine.tests.QuerySetTest.test_map_reduce`
and :meth:`~mongoengine.tests.QuerySetTest.test_map_advanced`
tests in ``tests.queryset.QuerySetTest`` for usage examples.
:param map_f: map function, as :class:`~pymongo.code.Code` or string
:param reduce_f: reduce function, as
:class:`~pymongo.code.Code` or string
:param finalize_f: finalize function, an optional function that
performs any post-reduction processing.
:param scope: values to insert into map/reduce global scope. Optional.
:param limit: number of objects from current query to provide
to map/reduce method
:param keep_temp: keep temporary table (boolean, default ``True``)
Returns a list of :class:`~mongoengine.document.MapReduceDocument`.
Returns an iterator yielding
:class:`~mongoengine.document.MapReduceDocument`.
.. note:: Map/Reduce requires server version **>= 1.1.1**. The PyMongo
:meth:`~pymongo.collection.Collection.map_reduce` helper requires
PyMongo version **>= 1.2**.
.. versionadded:: 0.2.2
.. todo:: Implement limits
"""
from document import MapReduceDocument

3
tests/queryset.py
View File

@ -601,7 +601,10 @@ class QuerySetTest(unittest.TestCase):
results = results.map_reduce(map_f, reduce_f, finalize_f=finalize_f)
results = list(results)
# assert troublesome Buzz article is ranked 1st
self.assertTrue(results[0].object.title.startswith("Google Buzz"))
# assert laser vision is ranked last
self.assertTrue(results[-1].object.title.startswith("How to see"))
Link.drop_collection()