Skip to content

Commit 0bd45f3

Browse files
authored
DOCS-16286-explain-executionStats-nReturned-incorrect-desc (#6132) (#6232)
* DOCS-16286-explain-executionStats-nReturned-incorrect-desc * Adding taxonomy tagging, updated duplicate section with new description. * Further clarifying after feedback, removing inaccurate explain.nReturned entry after external review. * Updating Compass procedure. * Removing nReturned from query example due to incorrect location. * Removing redundant taxonomy tags.
1 parent ab76eb5 commit 0bd45f3

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

source/reference/explain-results.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ execution of the winning plan. In order to include
444444

445445
.. data:: explain.executionStats.nReturned
446446

447-
Number of documents that match the query condition.
447+
Number of documents returned by the winning query plan.
448448
:data:`~explain.executionStats.nReturned` corresponds to the ``n`` field
449449
returned by ``cursor.explain()`` in earlier versions of MongoDB.
450450

source/tutorial/analyze-query-plan.txt

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Analyze Query Performance
44

55
.. default-domain:: mongodb
66

7+
.. facet::
8+
:name: programming_language
9+
:values: shell
10+
711
.. contents:: On this page
812
:local:
913
:backlinks: none
@@ -140,7 +144,7 @@ Query with No Index
140144

141145
- :data:`executionStats.nReturned
142146
<explain.executionStats.nReturned>` displays ``3`` to
143-
indicate that the query matches and returns three documents.
147+
indicate that the winning query plan returns three documents.
144148

145149
- :data:`executionStats.totalKeysExamined
146150
<explain.executionStats.totalKeysExamined>` displays ``0``
@@ -201,7 +205,7 @@ Query with No Index
201205
execution stats of the query:
202206

203207
- :guilabel:`Documents Returned` displays ``3`` to indicate
204-
that the query matches and returns three documents.
208+
that the winning query plan returns three documents.
205209

206210
- :guilabel:`Index Keys Examined` displays ``0`` to
207211
indicate that this query is not using an index.
@@ -299,8 +303,8 @@ To support the query on the ``quantity`` field, add an index on the
299303
``IXSCAN`` to indicate index use.
300304

301305
- :data:`executionStats.nReturned <explain.executionStats.nReturned>`
302-
displays ``3`` to indicate that the query matches and
303-
returns three documents.
306+
displays ``3`` to indicate that the winning query plan returns
307+
three documents.
304308

305309
- :data:`executionStats.totalKeysExamined
306310
<explain.executionStats.totalKeysExamined>` displays ``3``
@@ -366,7 +370,7 @@ To support the query on the ``quantity`` field, add an index on the
366370
execution stats of the query:
367371

368372
- :guilabel:`Documents Returned` displays ``3`` to indicate
369-
that the query matches and returns three documents.
373+
that the winning query plan returns three documents.
370374

371375
- :guilabel:`Index Keys Examined` displays ``3``
372376
to indicate that MongoDB scanned three index entries. The

0 commit comments

Comments
 (0)