进入MongoDB中文手册（4.2版本）专栏

1 Mongo Shell命令

cursor.explain(“executionStats”) 和db.collection.explain(“executionStats”)方法提供了有关查询的性能统计信息。这些统计信息可用于衡量查询是否以及如何使用索引。
db.collection.explain()提供有关其他操作执行的信息，例如db.collection.update()。请参见其详情。

1.1 评估查询的性能

考虑包含以下文档的inventory集合：

{ "_id" : 1, "item" : "f1", type: "food", quantity: 500 }
{ "_id" : 2, "item" : "f2", type: "food", quantity: 100 }
{ "_id" : 3, "item" : "p1", type: "paper", quantity: 200 }
{ "_id" : 4, "item" : "p2", type: "paper", quantity: 150 }
{ "_id" : 5, "item" : "f3", type: "food", quantity: 300 }
{ "_id" : 6, "item" : "t1", type: "toys", quantity: 500 }
{ "_id" : 7, "item" : "a1", type: "apparel", quantity: 250 }
{ "_id" : 8, "item" : "a2", type: "apparel", quantity: 400 }
{ "_id" : 9, "item" : "t2", type: "toys", quantity: 50 }
{ "_id" : 10, "item" : "f4", type: "food", quantity: 75 }

1.1.1 无索引的查询

以下查询检索值介于100和200之间的quantity字段的文档 ：

db.inventory.find( { quantity: { $gte: 100, $lte: 200 } } )

该查询返回以下文档：

{ "_id" : 2, "item" : "f2", "type" : "food", "quantity" : 100 }
{ "_id" : 3, "item" : "p1", "type" : "paper", "quantity" : 200 }
{ "_id" : 4, "item" : "p2", "type" : "paper", "quantity" : 150 }

要查看所选的查询计划，请将cursor.explain(“executionStats”) 游标方法链接到find命令的末尾：

db.inventory.find({ quantity: { $gte: 100, $lte: 200 } }
).explain("executionStats")

explain() 返回以下结果：

{"queryPlanner" : {"plannerVersion" : 1,..."winningPlan" : {"stage" : "COLLSCAN",...}},"executionStats" : {"executionSuccess" : true,"nReturned" : 3,"executionTimeMillis" : 0,"totalKeysExamined" : 0,"totalDocsExamined" : 10,"executionStages" : {"stage" : "COLLSCAN",...},...},...
}

• queryPlanner.winningPlan.stage显示 COLLSCAN，表示这是集合扫描。
  集合扫描表明， mongod必须逐个文档扫描整个集合文档以识别结果。这通常是一项很大开销的操作，并且可能导致查询缓慢。
• executionStats.nReturned显示3，表示查询匹配并返回三个文档。
• executionStats.totalKeysExamined显示0，表示这是查询未使用索引。
• executionStats.totalDocsExamined显示10，表示MongoDB必须扫描十个文档（即集合中的所有文档）才能找到三个匹配的文档。

匹配文档数和已检查文档数之间的差异可能建议，可以通过使用索引来提高查询的效率。

1.1.2 有索引的查询

要支持对quantity字段的查询，请在该字段上添加一个索引 quantity：

db.inventory.createIndex( { quantity: 1 } )

要查看查询计划统计信息，请使用以下 explain(“executionStats”)方法：

db.inventory.find({ quantity: { $gte: 100, $lte: 200 } }
).explain("executionStats")

explain()方法返回以下结果：

{"queryPlanner" : {"plannerVersion" : 1,..."winningPlan" : {"stage" : "FETCH","inputStage" : {"stage" : "IXSCAN","keyPattern" : {"quantity" : 1},...}},"rejectedPlans" : [ ]},"executionStats" : {"executionSuccess" : true,"nReturned" : 3,"executionTimeMillis" : 0,"totalKeysExamined" : 3,"totalDocsExamined" : 3,"executionStages" : {...},...},...
}

• queryPlanner.winningPlan.inputStage.stage显示 IXSCAN，表示使用了索引。
• executionStats.nReturned 显示3，表示查询匹配并返回三个文档。
• executionStats.totalKeysExamined显示3，表示MongoDB扫描了三个索引条目。检查的键数与返回的文档数相匹配，这意味着mongod只需检查索引键即可返回结果。mongod没有扫描所有的文件，只有三个匹配文档被放入内存中。这是一次非常有效的查询。
• executionStats.totalDocsExamined显示3，表示MongoDB扫描了三个文档。

没有索引，查询将扫描整个集合的10个文档并返回3个匹配的文档。该查询还必须扫描每个文档的整体，可能会将它们放到内存中。这导致这次查询操作开销很大且查询缓慢。
当使用索引运行时，查询会扫描3个索引条目和3个文档并返回3个匹配的文档，因此是一次非常高效的查询。

1.2 比较索引的性能

若要手动比较使用多个索引的查询的性能，可以将hint() 方法与explain() 方法结合使用。
考虑以下查询：

db.inventory.find( {quantity: {$gte: 100, $lte: 300},type: "food"
} )

查询返回以下文档：

{ "_id" : 2, "item" : "f2", "type" : "food", "quantity" : 100 }
{ "_id" : 5, "item" : "f3", "type" : "food", "quantity" : 300 }

要支持查询，请添加复合索引。对于复合索引，字段的顺序很重要。
例如，添加以下两个复合索引。第一个索引按quantity字段顺序排序，然后按 type字段排序。第二个索引按顺序排序type，然后按quantity字段排序。

db.inventory.createIndex( { quantity: 1, type: 1 } )
db.inventory.createIndex( { type: 1, quantity: 1 } )

评估第一个索引对查询的影响：

db.inventory.find({ quantity: { $gte: 100, $lte: 300 }, type: "food" }
).hint({ quantity: 1, type: 1 }).explain("executionStats")

explain()方法返回以下输出：

{"queryPlanner" : {..."winningPlan" : {"stage" : "FETCH","inputStage" : {"stage" : "IXSCAN","keyPattern" : {"quantity" : 1,"type" : 1},...}}},"rejectedPlans" : [ ]},"executionStats" : {"executionSuccess" : true,"nReturned" : 2,"executionTimeMillis" : 0,"totalKeysExamined" : 5,"totalDocsExamined" : 2,"executionStages" : {...}},...
}

MongoDB扫描了5个索引键（executionStats.totalKeysExamined）并返回2个匹配的文档（executionStats.nReturned）。
评估第二个索引对查询的影响：

db.inventory.find({ quantity: { $gte: 100, $lte: 300 }, type: "food" }
).hint({ type: 1, quantity: 1 }).explain("executionStats")

explain()方法返回以下输出：

{"queryPlanner" : {..."winningPlan" : {"stage" : "FETCH","inputStage" : {"stage" : "IXSCAN","keyPattern" : {"type" : 1,"quantity" : 1},...}},"rejectedPlans" : [ ]},"executionStats" : {"executionSuccess" : true,"nReturned" : 2,"executionTimeMillis" : 0,"totalKeysExamined" : 2,"totalDocsExamined" : 2,"executionStages" : {...}},...
}

MongoDB扫描了2个索引键（executionStats.totalKeysExamined）并返回2个匹配的文档（executionStats.nReturned）。
对于此示例查询，复合索引{ type: 1, quantity: 1 }比复合索引{ quantity: 1, type: 1 }效率更高。

2 Mongo Compass(图像管理工具)

MongoDB Compass提供了一个“解释计划(Explain Plan)” 选项卡，该选项卡显示有关查询性能的统计信息。这些统计信息可用于衡量查询是否以及如何使用索引。

2.1 评估查询的性能

考虑包含以下文档的inventory集合：

{ "_id" : 1, "item" : "f1", type: "food", quantity: 500 }
{ "_id" : 2, "item" : "f2", type: "food", quantity: 100 }
{ "_id" : 3, "item" : "p1", type: "paper", quantity: 200 }
{ "_id" : 4, "item" : "p2", type: "paper", quantity: 150 }
{ "_id" : 5, "item" : "f3", type: "food", quantity: 300 }
{ "_id" : 6, "item" : "t1", type: "toys", quantity: 500 }
{ "_id" : 7, "item" : "a1", type: "apparel", quantity: 250 }
{ "_id" : 8, "item" : "a2", type: "apparel", quantity: 400 }
{ "_id" : 9, "item" : "t2", type: "toys", quantity: 50 }
{ "_id" : 10, "item" : "f4", type: "food", quantity: 75 }

这些文档在MongoDB Compass中的显示如下：

2.1.1 无索引的查询

以下查询检索值介于100和200之间的quantity字段的文档 ：
将以下过滤器复制到“Compass”查询栏中，然后单击“ 查找/Find”：

{ quantity: { $gte: 100, $lte: 200 } }

该查询返回以下文档：

要查看所选的查询计划：

• 点击test.inventory集合的“ Explain Plan”选项卡 。
• 点击Explain。

MongoDB Compass显示查询计划，如下所示：

注意
因为在本教程中我们使用的数据集很小，所以即使我们没有使用索引，“ 实际查询执行时间(Actual Query Execution Time)”也会显示0秒。

在更大的数据集中，索引查询与非索引查询之间的查询执行时间差异会更大。

虚拟数(Visual Tree)

• 查询性能概要（Query Performance Summary）显示查询的执行统计：
  • “返回的文档(Documents Returned)”显示3，表示查询匹配并返回三个文档。
  • “ 已检查索引键(Index Keys Examined)”显示0表示此查询未使用索引。
  • 已检查的文档(Documents Examined)显示10，表明MongoDB必须扫描十个文档（即集合中的所有文档）才能找到三个匹配的文档。
• 在“ 查询性能概要（Query Performance Summary）”下，MongoDB Compass显示COLLSCAN查询阶段，表示该查询使用了集合扫描。
  集合扫描表明， mongod必须逐个文档扫描整个集合文档以识别结果。这通常是一项很大开销的操作，并且可能导致查询缓慢。

原始JSON(Raw JSON)
也可以通过单击查询栏下方的Raw JSON以原始JSON格式展示explain的详细信息：

匹配文档数和已检查文档数之间的差异可能建议，可以通过使用索引来提高查询的效率。

2.1.2 有索引的查询

要支持对该quantity字段的查询，请在该字段上添加一个索引 quantity：

• 单击test.inventory集合的“ 索引(Indexes )”选项卡 。
• 点击创建索引(Create Index)。
• 从 选择一个字段名称（Select a field name）的下拉框选择quantity。
• 从类型下拉列表中选择1 (asc)。
• 点击创建(Create)。
  

注意
将索引名称字段保留为空白会导致MongoDB Compass为索引创建默认名称。

现在，您可以在“ 索引(Indexes )”选项卡中查看新创建的 索引：

返回到inventory集合的“ 解释计划(Explain Plan)”选项卡， 然后从上一步重新运行查询：

虚拟数(Visual Tree)

• 查询性能概要（Query Performance Summary）显示查询的执行统计：
  • “返回的文档(Documents Returned)”显示3，表示查询匹配并返回三个文档。
  • “ 已检查索引键(Index Keys Examined)”显示3，MongoDB扫描了三个索引条目。检查的键数与返回的文档数相匹配，这意味着mongod只需检查索引键即可返回结果。mongod没有扫描所有的文件，只有三个匹配文档被放入内存中。这是一次非常有效的查询。
  • 已检查的文档(Documents Examined)显示3，表明MongoDB扫描了三个文档。
• 在“ 查询性能概要（Query Performance Summary）”下，MongoDB Compass显示FETCH 和IXSCAN查询阶段， IXSCAN表示mongod在执行FETCH阶段和检索文档之前使用索引查询。

原始JSON(Raw JSON)
也可以通过单击查询栏下方的Raw JSON以原始JSON格式展示explain的详细信息：

没有索引，查询将扫描整个集合的10个文档并返回3个匹配的文档。该查询还必须扫描每个文档的整体，可能会将它们放到内存中。这导致这次查询操作开销很大且查询缓慢。
当使用索引运行时，查询会扫描3个索引条目和3个文档并返回3个匹配的文档，因此是一次非常高效的查询。

也可以看看

• 查询优化；
• MongoDB Compass文档；
• Compass查询计划文档。

进入MongoDB中文手册（4.2版本）专栏