Skip to content

Commit 1d67934

Browse files
committed
Document recently added query parameters.
1 parent 42c2ce4 commit 1d67934

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

doc/api/pymongo/collection.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
.. automethod:: update(spec, document[, upsert=False[, manipulate=False[, safe=False[, multi=False[, **kwargs]]]]])
3131
.. automethod:: remove([spec_or_object_id=None[, safe=False[, **kwargs]]])
3232
.. automethod:: drop
33-
.. automethod:: find([spec=None[, fields=None[, skip=0[, limit=0[, timeout=True[, snapshot=False[, tailable=False[, sort=None[, max_scan=None[, as_class=None[, slave_okay=False[, **kwargs]]]]]]]]]]]])
33+
.. automethod:: find([spec=None[, fields=None[, skip=0[, limit=0[, timeout=True[, snapshot=False[, tailable=False[, sort=None[, max_scan=None[, as_class=None[, slave_okay=False[, await_data=False[, partial=False[, manipulate=True[, **kwargs]]]]]]]]]]]]]]])
3434
.. automethod:: find_one([spec_or_id=None[, *args[, **kwargs]]])
3535
.. automethod:: count
3636
.. automethod:: create_index

pymongo/collection.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -546,13 +546,26 @@ def find(self, *args, **kwargs):
546546
:attr:`~pymongo.connection.Connection.document_class`)
547547
- `slave_okay` (optional): if True, allows this query to
548548
be run against a replica secondary.
549+
- `await_data` (optional): if True, the server will block for
550+
some extra time before returning, waiting for more data to
551+
return. Ignored is `tailable` is False.
552+
- `partial` (optional): if True, mongos will return partial
553+
results if some shards are down instead of returning an error.
554+
- `manipulate`: (optional): If True (the default), apply any
555+
outgoing SON manipulators before returning.
549556
- `network_timeout` (optional): specify a timeout to use for
550557
this query, which will override the
551558
:class:`~pymongo.connection.Connection`-level default
552559
560+
.. note:: The `manipulate` parameter may default to False in
561+
a future release.
562+
553563
.. note:: The `max_scan` parameter requires server
554564
version **>= 1.5.1**
555565
566+
.. versionadded:: 1.11+
567+
The `await_data`, `partial`, and `manipulate` parameters.
568+
556569
.. versionadded:: 1.8
557570
The `network_timeout` parameter.
558571

0 commit comments

Comments
 (0)