db.collection.explain()

Verbosity 模式

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

解释和写入操作

对于写入操作，db.collection.explain() 会返回将要执行的写入操作的相关信息，但不会实际修改数据库。

限制

对于包含 $out 阶段的 aggregation pipeline，不能在 executionStats 模式或 allPlansExecution 模式下运行 explain 命令/db.collection.explain()。取而代之的是，您可以：

• 在 queryPlanner 模式下运行 explain，或者

• 在 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.find().explain() 返回一个游标，需要调用 .next() 或其别名 .finish() 才能返回 explain() 结果。如果在 mongosh 中交互运行，mongosh 会自动调用 .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" 详细模式运行。

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

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

executionStats 模式

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

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

allPlansExecution 模式

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

db.products.explain( "allPlansExecution" ).findAndModify( {
   query: { name: "Tom", state: "active", rating: { $gt: 10 } },
   sort: { rating: 1 },
   update: { $inc: { score: 1 } }
} )

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 } )

有关可用查询修饰符的列表，请在 mongosh 中运行以下命令：

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

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

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

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