[DOCS-4305] 2.8 - explain shell methods Created: 10/Nov/14  Updated: 16/Mar/15  Resolved: 19/Nov/14

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: v1.3.14, mongodb-3.0

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Kay Kim (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related
related to DOCS-4370 Doc retry behavior of explain shell h... Closed
Participants:
Days since reply: 9 years, 9 weeks ago

 Description   

db.foo.explain().
.aggregate(...) - explain an aggregation operation
.count(...) - explain a count operation
.find(...) - get an explainable query
.group(...) - explain a group operation
.remove(...) - explain a remove operation
.update(...) - explain an update operation
Explainable collection methods
.getCollection()
.getVerbosity()
.setVerbosity(verbosity)
...

Note the ability to chain
db.foo.explain().find()
Explain query methods
.finish() - sends explain command to the server and returns the result
.forEach(func) - apply a function to the explain results
.hasNext() - whether this explain query still has a result to retrieve
.next() - alias for .finish()

Explain query modifiers
.addOption
.batchSize
...



 Comments   
Comment by Githook User [ 17/Dec/14 ]

Author:

{u'username': u'kay-kim', u'name': u'kay', u'email': u'kay.kim@10gen.com'}

Message: DOCS-4305 db.collection.explain
Branch: master
https://github.com/mongodb/docs/commit/3b97142d1d4dae67402b42565a3943418db0b1cf

Generated at Thu Feb 08 07:47:41 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.