explain

定义

explain

的explain 命令提供了以下命令的执行信息aggregate、count、distinct、find、findAndModify、delete、mapReduce 和 update.

提示

在 mongosh 中，此命令也可以通过 db.collection.explain() 和 cursor.explain() 辅助方法运行。.

辅助方法对 mongosh 用户来说很方便，但它们可能不会返回与数据库命令相同级别的信息。在不需要方便性或需要额外返回字段的情况下，请使用数据库命令。

注意

使用 explain 会忽略所有现有的计划缓存条目，并阻止 MongoDB 查询规划器创建新的计划缓存条目。

兼容性

此命令在以下环境中托管的部署中可用

• MongoDB Atlas：云中 MongoDB 部署的全托管服务

• MongoDB Enterprise：基于订阅、自行管理的 MongoDB 版本

• MongoDB Community：源代码可用的、免费使用和自行管理的 MongoDB 版本

语法

该命令具有以下语法

db.runCommand(
   {
     explain: <command>,
     verbosity: <string>,
     comment: <any>
   }
)

命令字段

该命令包含以下字段

行为

输出

explain操作可以返回有关

• explainVersion（输出格式版本，例如，“1”）的信息。

• command（正在解释的命令的详细信息）。

• queryShapeHash（从MongoDB 8.0开始，这是一个包含查询形状散列的十六进制字符串。有关详细信息，请参阅查询形状、查询形状、查询形状散列和explain.queryShapeHash。）

• queryPlanner（查询优化器选择的计划以及拒绝的计划）。

• executionStats（获胜计划的执行以及拒绝的计划的执行）。

• serverInfo（提供MongoDB实例的信息）。

• serverParameters，该代码详细说明了内部参数。

详细模式（即 queryPlanner、executionStats、allPlansExecution）决定了结果是否包含 executionStats，以及是否 executionStats 包含在 计划选择 过程中捕获的数据。

解释输出受最大 BSON 文档嵌套深度 的限制，嵌套深度为 100 层。超出限制的解释输出将被截断。

有关输出的详细信息，请参阅 解释结果。

示例

db.runCommand(
   {
     explain: { count: "products", query: { quantity: { $gt: 50 } } },
     verbosity: "queryPlanner"
   }
)

db.runCommand(
   {
      explain: { count: "products", query: { quantity: { $gt: 50 } } },
      verbosity: "executionStats"
   }
)

db.runCommand(
   {
     explain: {
        update: "products",
        updates: [
           {
               q: { quantity: 1057, category: "apparel" },
               u: { $set: { reorder: true } }
           }
        ]
     }
   }
)