db.collection.explain（）

详细模式¶

的行为db.collection.explain()和返回的信息量取决于verbosity模式。

解释和写入操作¶

对于写操作，db.collection.explain()返回有关将要执行但实际上并未修改数据库的写操作的信息。

限制¶

在MongoDB中4.2开始，你不能运行explain 命令/ db.collection.explain()在executionStats模式或allPlansExecution一个模式包含阶段。相反，您可以：aggregation pipeline$out

• 以queryPlanner方式运行说明或
• 在executionStats模式或allPlansExecution 模式下运行说明，但没有该$out阶段以返回该阶段之前的$out阶段的信息。

explain()力学¶

该db.collection.explain()方法包装 explain命令，是首选的运行方式 explain。

db.collection.explain().find()db.collection.find().explain()与以下主要区别相似 ：

• 该db.collection.explain().find()构造允许查询修饰符的其他链接。有关查询修饰符的列表，请参见db.collection.explain（）。find（）。help（）。
• 在db.collection.explain().find()返回游标，这需要一个电话.next()，或它的别名.finish()，返回explain()结果。如果在mongo外壳中以交互方式运行，则 mongo外壳会自动调用.finish()以返回结果。但是，对于脚本，必须显式调用 .next()或.finish()，以返回结果。有关与游标相关的方法的列表，请参见 db.collection.explain（）。find（）。help（）。

db.collection.explain().aggregate()等效于将说明选项传递给该db.collection.aggregate()方法。

help()¶

要查看所支持的操作列表 db.collection.explain()，请运行：

db.collection.explain().help()

db.collection.explain().find()返回一个游标，它允许链接查询修饰符。要查看受支持的查询修饰符db.collection.explain().find()以及与光标相关的方法的列表，请运行：

db.collection.explain().find().help()

您可以将多个修饰符链接到db.collection.explain().find()。有关示例，请参见解释带有修饰符的find（）。

queryPlanner模式¶

默认情况下，db.collection.explain()以"queryPlanner"详细模式运行 。

以下示例db.collection.explain()以"queryPlanner"详细模式运行， 以返回指定count()操作的查询计划信息：

db.products.explain().count( { quantity: { $gt: 50 } } )

executionStats 模式¶

以下示例db.collection.explain()以"executionStats"详细模式运行， 以返回指定find()操作的查询计划和执行信息：

db.products.explain("executionStats").find(
   { quantity: { $gt: 50 }, category: "apparel" }
)

allPlansExecution模式¶

以下示例db.collection.explain()在 "allPlansExecution"详细模式下运行。对于指定的操作，将 db.collection.explain()返回 queryPlanner和executionStats对于所有考虑的计划 update()：

db.products.explain("allPlansExecution").update(
   { quantity: { $lt: 1000}, category: "apparel" },
   { $set: { reorder: true } }
)

find()用修饰符解释¶

db.collection.explain().find()构造允许链接查询修饰符。例如，以下操作提供有关find()带有sort()和hint()查询修饰符的方法的 信息。

db.products.explain("executionStats").find(
   { quantity: { $gt: 50 }, category: "apparel" }
).sort( { quantity: -1 } ).hint( { category: 1, quantity: -1 } )

有关可用的查询修饰符的列表，请在mongo 外壳程序中运行：

db.collection.explain().find().help()

迭代explain().find()返回游标¶

db.collection.explain().find()将光标返回到解释结果。如果在mongo外壳中以交互方式运行，则mongo外壳会使用.next()方法自动迭代光标 。但是，对于脚本，必须显式调用 .next()（或其别名.finish()）以返回结果：

var explainResult = db.products.explain().find( { category: "apparel" } ).next();