[SERVER-10448] Revamp explain() formatting Created: 07/Aug/13  Updated: 27/Oct/15  Resolved: 29/Oct/14

Status: Closed
Project: Core Server
Component/s: Querying
Affects Version/s: None
Fix Version/s: 2.8.0-rc0

Type: Improvement Priority: Major - P3
Reporter: kulathur rajasethupathy Assignee: David Storch
Resolution: Done Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
is depended on by DRIVERS-164 Support changes to explain in MongoDB... Closed
Duplicate
is duplicated by SERVER-12792 incorrect nscannedObjects for explain... Closed
is duplicated by SERVER-14610 Detailed explain does not list reject... Closed
is duplicated by SERVER-7054 make explain output more informative ... Closed
Related
related to SERVER-15020 Implement explain for the distinct co... Closed
related to SERVER-19758 Add "executionStats" and "allPlansExe... Closed
related to SERVER-15330 Bump maxWireProtocolVersion for 2.8 f... Closed
related to SERVER-16053 explain shell helpers should retry us... Closed
related to SERVER-14086 explain() doesn't display plan inform... Closed
related to SERVER-17347 .explain() should be included in the ... Closed
is related to SERVER-3493 count command should give indexinfo Closed
is related to SERVER-8747 In explain output, per plan 'n' count... Closed
is related to SERVER-8912 Metric "document.scanned" is not the ... Closed
is related to SERVER-9126 Cannot get query plan or status for d... Closed
is related to SERVER-11771 extended options for $regex cannot be... Closed
is related to SERVER-2845 when using skip, objects still report... Closed
is related to SERVER-5759 indexOnly in explain() is not reporte... Closed
is related to SERVER-8957 Explain on 2dsphere find query includ... Closed
is related to SERVER-12037 Add additional information to $text q... Closed
is related to DOCS-4307 explain - output and how to interpret Closed
is related to SERVER-8997 Display yield time where we display y... Open
is related to SERVER-1812 Add the ability to get query results ... Backlog
is related to SERVER-2235 IndexScan should track the number of ... Closed
is related to SERVER-3401 Add faults/idx-miss to explain and pr... Closed
is related to SERVER-4494 explain output should include index v... Closed
is related to SERVER-4755 sharded explain should return shard n... Closed
is related to SERVER-8208 support explain() without actually ex... Closed
is related to SERVER-8659 Allow projections with dotted fields ... Closed
is related to SERVER-11975 All Runners should support getExplain... Closed
is related to SERVER-15167 Improve explain visibility of $min/$m... Closed
is related to SERVER-3495 Include sparse/attr in explain output Closed
is related to SERVER-5336 explain() cursor field should store i... Closed
is related to SERVER-12533 Include sort (spec) for sort stage in... Closed
Backwards Compatibility: Minor Change
Sprint: Query 2.7.8
Participants:

 Description   

Provide new explain format with debugging information and both runtime stats and static query information.

Deprecate inapplicable old format.



 Comments   
Comment by Githook User [ 02/Oct/14 ]

Author:

{u'username': u'dstorch', u'name': u'David Storch', u'email': u'david.storch@10gen.com'}

Message: SERVER-10448 explained operations should not use the plan cache
Branch: master
https://github.com/mongodb/mongo/commit/95c3ccb36529db9841abd3a7e876ea66aac69420

Comment by Githook User [ 15/Sep/14 ]

Author:

{u'username': u'dstorch', u'name': u'David Storch', u'email': u'david.storch@10gen.com'}

Message: SERVER-10448 change default explain mode from queryPlanner to executionStats
Branch: master
https://github.com/mongodb/mongo/commit/27000b67341e508294e37082bc05a0705e4f6b69

Comment by Githook User [ 31/Jul/14 ]

Author:

{u'username': u'dstorch', u'name': u'David Storch', u'email': u'david.storch@10gen.com'}

Message: SERVER-10448 migrate code out of explain_plan.cpp
Branch: master
https://github.com/mongodb/mongo/commit/b494ade9a9461d16ab3812640ca72ee9c9e4345c

Comment by Githook User [ 21/Jul/14 ]

Author:

{u'username': u'dstorch', u'name': u'David Storch', u'email': u'david.storch@10gen.com'}

Message: SERVER-10448 fix candidate deletion in multi plan stage
Branch: master
https://github.com/mongodb/mongo/commit/17a35699a9d760965e22e1d3f7ffc813e4edb658

Comment by kulathur rajasethupathy [ 19/Aug/13 ]

well.

some example outputs of explain() could be:

was an index used: yes/no:
if yes what is name of the index used:
was an index used for query match only: yes/no
was an index used for sort only: yes/no
was an index used for both query match and sort: yes/no

number of documents returned:
number of documents scanned:
number of indexes scanned:

was a scan done before sort: yes/no
was a sort done before scan: yes/no

hope it helps.

Comment by David Hows [ 12/Aug/13 ]

Hi Kulathur,

Thanks for the feedback. We are always looking for ways to improve our user experience, especially for power users.

To that end, can you give some detail about which specific parts of the explain() are unclear or confusing? And what about those parts is not confusing.

If we know specifically which parts are confusing, we can address those directly and have a more profound impact on usability going forward.

Thanks,
David

Generated at Thu Feb 08 03:23:12 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.