Skip to content

Commit fe30705

Browse files
committed
PYTHON-1656 explain() uses server default verbosity
1 parent c0c7c05 commit fe30705

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

pymongo/cursor.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -801,6 +801,13 @@ def distinct(self, key):
801801
def explain(self):
802802
"""Returns an explain plan record for this cursor.
803803
804+
.. note:: Starting with MongoDB 3.2 :meth:`explain` uses
805+
the default verbosity mode of the `explain command
806+
<https://docs.mongodb.com/manual/reference/command/explain/>`_,
807+
``allPlansExecution``. To use a different verbosity use
808+
:meth:`~pymongo.database.Database.command` to run the explain
809+
command directly.
810+
804811
.. mongodoc:: explain
805812
"""
806813
c = self.clone()

0 commit comments

Comments
 (0)