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

Added docs for no_dereference and scalar (#68)

Browse Source
This commit is contained in:
Ross Lawley 2013-01-24 17:41:21 +00:00
parent ba48dfb4bf
commit 9f551121fb
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
mongoengine/queryset/queryset.py
View File

@ -748,8 +748,12 @@ class QuerySet(object):
"""Instead of returning Document instances, return either a specific """Instead of returning Document instances, return either a specific
value or a tuple of values in order. value or a tuple of values in order.
This effects all results and can be unset by calling ``scalar`` Can be used along with
without arguments. Calls ``only`` automatically. :func:`~mongoengine.queryset.QuerySet.no_dereference` to turn off
dereferencing.
.. note:: This effects all results and can be unset by calling
``scalar`` without arguments. Calls ``only`` automatically.
:param fields: One or more fields to return instead of a Document. :param fields: One or more fields to return instead of a Document.
""" """
@ -1139,7 +1143,8 @@ class QuerySet(object):
return self.__dereference return self.__dereference
def no_dereference(self): def no_dereference(self):
"""Turn off any dereferencing.""" """Turn off any dereferencing for the results of this queryset.
"""
queryset = self.clone() queryset = self.clone()
queryset._auto_dereference = False queryset._auto_dereference = False
return queryset return queryset