MongoDB Explain

1. 简介

在使用 MongoDB 数据库进行查询时，我们可以通过 explain() 方法来获取查询执行的详细信息。Explain 的结果可以帮助我们了解查询的执行计划、索引使用情况以及性能优化的建议。

2. explain() 方法

explain() 方法是在 MongoDB shell 中用于查询执行计划解释的一个命令。它可以用于解释各种类型的查询操作，包括 find、aggregate、count 等。

2.1 explain() 方法的语法

db.collection.explain().<action>()

对于 find 操作，我们可以使用 explain 方法来获取查询的执行计划：

db.collection.find(<query>).explain()

2.2 explain() 的结果解释

当我们使用 explain 方法后，会得到一个包含查询执行计划信息的文档。该文档中包含了以下几个关键字段：

• queryPlanner: 查询计划器相关信息。
• executionStats: 查询执行统计相关信息。
• serverInfo: MongoDB 服务器信息。
• ok: 标示查询是否成功。

2.3 explain() 方法示例

让我们通过一个具体的示例来演示 explain 方法的使用。

假设我们有一个 students 集合，其中包含了学生的成绩信息。

[
  { name: "Alice", score: 85 },
  { name: "Bob", score: 92 },
  { name: "Charlie", score: 78 },
  { name: "David", score: 90 }
]

我们想获取成绩高于 80 分的学生信息。现在让我们使用 explain 方法来解释该查询的执行计划：

db.students.find({ score: { $gt: 80 } }).explain()

执行上述命令后，我们会得到类似下面的输出：

{
  "queryPlanner": {
    "plannerVersion": 1,
    "namespace": "test.students",
    "indexFilterSet": false,
    "parsedQuery": {
      "score": {
        "gt": 80
      }
    },
    "winningPlan": {
      "stage": "COLLSCAN",
      "filter": {
        "score": {
          "gt": 80
        }
      },
      "direction": "forward"
    },
    "rejectedPlans": []
  },
  "executionStats": {
    "executionSuccess": true,
    "nReturned": 2,
    "executionTimeMillis": 0,
    "totalKeysExamined": 0,
    "totalDocsExamined": 4,
    "executionStages": {
      "stage": "COLLSCAN",
      "filter": {
        "score": {
          "gt": 80
        }
      },
      "nReturned": 2,
      "executionTimeMillisEstimate": 0,
      "works": 6,
      "advanced": 2,
      "needTime": 3,
      "needFetch": 0,
      "saveState": 0,
      "restoreState": 0,
      "isEOF": 1,
      "direction": "forward",
      "docsExamined": 4
    }
  },
  "serverInfo": {
    "host": "localhost",
    "port": 27017,
    "version": "4.4.1",
    "gitVersion": "unknown",
    "modules": [],
    "openssl": {
      "running": "not-compiled",
      "compiled": "---",
      "target": "---"
    },
    "sasl_supported_mechs": [
      "SCRAM-SHA-1",
      "SCRAM-SHA-256"
    ],
    "me": "localhost:27017",
    "ismaster": true,
    "topologyVersion": {
      "processId": ObjectId("xxx"),
      "counter": NumberLong(0)
    },
    "ok": 1,
    "clusterTime": {
      "clusterTime": Timestamp(1634233493, 1),
      "signature": {
        "hash": BinData(0, "0000000000000000000000000000000000000000"),
        "keyId": NumberLong(0)
      }
    },
    "operationTime": Timestamp(1634233493, 1)
  },
  "ok": 1
}

从上述输出可以看出，queryPlanner 字段展示了查询的执行计划，executionStats 字段包含了查询的执行统计信息。

3. 使用 explain() 进行性能优化

在开发 MongoDB 查询时，explain 方法可以帮助我们分析查询的性能，从而进行优化。下面介绍一些常用的优化技巧：

3.1 创建索引

如果查询的字段没有索引，那么查询可能会需要进行全表扫描，导致性能下降。因此，在设计数据库时，要根据查询需求创建适当的索引。

例如，对于上述示例中的成绩查询，可以在 score 字段上创建一个索引：

db.students.createIndex({ score: 1 })

创建索引后，重新执行查询并使用 explain 方法，可以发现查询计划中的 winningPlan 变为了 IXSCAN，表明索引已经被使用。

3.2 理解执行计划

通过阅读 explain 的结果，我们可以了解查询的执行计划是如何选择的。例如，查询计划器选择了一个全表扫描，说明可能缺少合适的索引。

explain 的输出中有一个 stage 字段，它描述了 MongoDB 查询引擎的执行过程。常见的执行阶段包括 COLLSCAN（全表扫描）、IXSCAN（索引扫描）、FETCH（获取文档）等。

理解执行计划并根据实际需求进行调整，可以优化查询性能。

3.3 查看查询统计信息

explain 的结果还包含了查询的统计信息，如执行时间、扫描的文档数量等。

通过分析统计信息，我们可以了解查询的性能瓶颈所在，从而有针对性地进行性能优化。

4. 小结

在本文中，我们详细介绍了 MongoDB 的 explain 方法及其使用。通过使用 explain 方法，我们可以了解查询的执行计划、索引使用情况以及性能优化的建议。