db. 集合.explain()（mongosh方法）

参数

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。 集合().find().help()。

• db.collection.find().explain() 返回有关查询计划的 explain() 信息。

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()。

分片集群

如果对分片集群上不存在的数据库运行db.collection.explain()，则执行阶段将到达流结束，并且该操作不会创建该数据库。有关流结束执行统计信息的更多信息，请参阅 explain.executionStats.executionStages.isEOF。

queryPlanner 模式

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

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

db.movies.explain().count( { year: { $gt: 2000 } } )

executionStats 模式

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

db.movies.explain("executionStats").find(
   { year: { $gt: 2000 }, rated: "PG" }
)

allPlansExecution 模式

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

db.movies.explain( "allPlansExecution" ).findAndModify( {
   query: { rated: "PG", year: { $gt: 2000 } },
   sort: { year: 1 },
   update: { $inc: { "imdb.votes": 1 } }
} )

用修饰符解释 find()

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

db.movies.explain("executionStats").find(
   { year: { $gt: 2000 }, rated: "PG" }
).sort( { year: -1 } ).hint( { rated: 1, year: -1 } )

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

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

使用 finish() 方法访问 explain() 结果

db.collection.explain().find() 返回 explain() 结果。如果在 mongosh 中以交互方式运行，则可以使用 .finish() 方法访问权限查询计划：

db.movies.explain().find( { rated: "PG" } ).finish().queryPlanner.winningPlan