[DOCS-11277] Consider slight clarification of `explain.executionStats.totalDocsExamined` Created: 02/Feb/18  Updated: 30/Oct/23  Resolved: 16/Jan/19

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Trivial - P5
Reporter: Chris Harris Assignee: Kay Kim (Inactive)
Resolution: Fixed Votes: 0
Labels: explain
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

https://docs.mongodb.com/manual/reference/explain-results/#explain.executionStats.totalDocsExamined


Issue Links:
Related
is related to DOCS-7086 Consider documenting "seeks" IXSCAN s... Closed
is related to SERVER-16512 totalDocsExamined is counted twice in... Closed
Participants:
Days since reply: 5 years, 4 weeks ago
Epic Link: DOCSP-1769
Story Points: 0.2

 Description   

Currently the "Explain Results" page defines Number of documents scanned as:

Number of documents scanned.

Generally, and intuitively, this would mean the number of distinct documents examined. However, this is not always the case and leads to confusion sometimes (eg SERVER-16512). A minor change in the docs to clarify this point might prevent that.



 Comments   
Comment by Githook User [ 16/Jan/19 ]

Author:

{'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}

Message: DOCS-7086,DOCS-11277: seeks metrics for IXSCAN stages in explain + totalDocsExamined clarification
Branch: v3.4
https://github.com/mongodb/docs/commit/bef74b4a35b3ef874dd56205995abd93ca53919c

Comment by Githook User [ 16/Jan/19 ]

Author:

{'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}

Message: DOCS-7086,DOCS-11277: seeks metrics for IXSCAN stages in explain + totalDocsExamined clarification
Branch: v3.6
https://github.com/mongodb/docs/commit/42819ac64cb6bbcad5266d72ad346993824aa32b

Comment by Githook User [ 16/Jan/19 ]

Author:

{'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}

Message: DOCS-7086,DOCS-11277: seeks metrics for IXSCAN stages in explain + totalDocsExamined clarification
Branch: v4.0
https://github.com/mongodb/docs/commit/e5a47e71e6aa01d7caae373637145ae6812d254b

Comment by Githook User [ 16/Jan/19 ]

Author:

{'email': 'kay.kim@mongodb.com', 'name': 'Kay Kim'}

Message: DOCS-7086,DOCS-11277: seeks metrics for IXSCAN stages in explain + totalDocsExamined clarification
Branch: master
https://github.com/mongodb/docs/commit/e60c4dc9e756c9c7ff451a6f61960d466ee43b58

Generated at Thu Feb 08 08:02:28 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.