解释

定义

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 版本

必需的访问权限

要使用 explain ，您必须有权运行根本的命令。

语法

该命令具有以下语法：

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

命令字段

该命令接受以下字段：

行为

输出

explain 操作可以返回以下信息：

• explainVersion，输出格式版本（例如 "1"）。

• command，其中详细说明了要解释的命令。

• queryShapeHash，从MongoDB 8.0 开始，是一个十六进制 string，具有查询结构的哈希值。有关详情，请参阅查询结构、查询结构哈希和 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 } }
           }
        ]
     }
   }
)