Explain plan analysis (queryPlanner, executionStats) in MongoDB

Introduction

Explain plan analysis helps you understand how MongoDB runs your query. It shows the steps MongoDB takes to find your data and how long it takes.

You want to see if your query is using indexes to be faster.

You need to find why a query is slow and how to improve it.

You want to check how many documents MongoDB scans to answer your query.

You want to compare different query methods to pick the best one.

Syntax

MongoDB

db.collection.find(query).explain('executionStats')

queryPlanner shows the plan MongoDB chooses to run your query.

executionStats adds details about how many documents were scanned and how long it took.

Examples

Shows the query plan without execution details.

MongoDB

db.users.find({ age: { $gt: 25 } }).explain('queryPlanner')

Shows the query plan plus how many documents were scanned and time taken.

MongoDB

db.users.find({ age: { $gt: 25 } }).explain('executionStats')

Defaults to queryPlanner mode if no argument is given.

MongoDB

db.users.find({ name: 'Alice' }).explain()

Sample Program

This inserts three users, then runs a query to find users older than 25. It shows the query plan and execution stats.

MongoDB

db.users.insertMany([
  { name: 'Alice', age: 30 },
  { name: 'Bob', age: 20 },
  { name: 'Carol', age: 35 }
])

const result = db.users.find({ age: { $gt: 25 } }).explain('executionStats')
printjson(result)

Important Notes

If your query does not use an index, MongoDB will do a collection scan (COLLSCAN), which is slower.

Look at totalDocsExamined vs nReturned to see efficiency.

Use explain('executionStats') to get detailed timing and document counts.

Summary

Explain plan shows how MongoDB runs your query step-by-step.

Use queryPlanner to see the plan chosen.

Use executionStats to see how many documents were scanned and how long it took.

Practice

1. What does the queryPlanner section in MongoDB's explain output show?

easy

A. The plan MongoDB chooses to execute the query

B. The total time taken to run the query

C. The number of documents returned by the query

D. The syntax errors in the query

Solution

1. Step 1: Understand the role of queryPlanner

   The queryPlanner shows the strategy MongoDB picks to run the query, like which indexes it uses.

2. Step 2: Differentiate from executionStats

   executionStats shows runtime details, not the plan itself.

3. Final Answer:

   The plan MongoDB chooses to execute the query -> Option A

4. Quick Check:

   queryPlanner = plan chosen [OK]

Hint: queryPlanner shows the plan, executionStats shows runtime [OK]

Common Mistakes:

• Confusing queryPlanner with executionStats
• Thinking queryPlanner shows query results
• Assuming queryPlanner shows errors

2. Which of the following is the correct way to get execution stats for a query in MongoDB?

easy

A. db.collection.find({}).explain('runStats')

B. db.collection.find({}).explain('queryPlan')

C. db.collection.find({}).explain('statsExecution')

D. db.collection.find({}).explain('executionStats')

Solution

1. Step 1: Recall the correct explain verbosity

   MongoDB uses 'executionStats' to show runtime details.

2. Step 2: Check option syntax

   Only db.collection.find({}).explain('executionStats') uses the correct string 'executionStats' with explain().

3. Final Answer:

   db.collection.find({}).explain('executionStats') -> Option D

4. Quick Check:

   Use 'executionStats' for runtime info [OK]

Hint: Use 'executionStats' string inside explain() for runtime stats [OK]

Common Mistakes:

• Using wrong strings like 'queryPlan' or 'runStats'
• Forgetting quotes around verbosity string
• Confusing method chaining order

3. Given this explain output snippet:

{
  "executionStats": {
    "nReturned": 5,
    "totalDocsExamined": 100,
    "executionTimeMillis": 12
  }
}

What does totalDocsExamined tell you?

medium

A. Number of documents returned by the query

B. Number of documents scanned to find matches

C. Total documents in the collection

D. Number of indexes used

Solution

1. Step 1: Understand totalDocsExamined meaning

   This value shows how many documents MongoDB looked at to find matching results.

2. Step 2: Differentiate from nReturned

   nReturned is how many documents matched and were returned, not scanned.

3. Final Answer:

   Number of documents scanned to find matches -> Option B

4. Quick Check:

   totalDocsExamined = docs scanned [OK]

Hint: totalDocsExamined counts scanned docs, not returned [OK]

Common Mistakes:

• Confusing scanned docs with returned docs
• Thinking it counts indexes used
• Assuming it is total collection size

4. You run db.users.find({age: 30}).explain('executionStat') but get an error. Which is the likely cause?

medium

A. The verbosity string 'executionStats' is misspelled

B. Explain does not support 'executionStats' verbosity

C. The query filter syntax is invalid

D. The collection name is incorrect

Solution

1. Step 1: Check common explain errors

   Misspelling the verbosity string causes errors because MongoDB expects exact strings.

2. Step 2: Validate other options

   Collection name and query syntax are valid; 'executionStats' is supported.

3. Final Answer:

   The verbosity string 'executionStats' is misspelled -> Option A

4. Quick Check:

   Correct spelling of verbosity string is required [OK]

Hint: Check spelling of verbosity string in explain() [OK]

Common Mistakes:

• Misspelling 'executionStats' as 'executionStat'
• Assuming explain() doesn't support 'executionStats'
• Blaming query syntax without checking verbosity

5. You want to optimize a query that scans 1000 documents but returns only 2. The explain output shows totalDocsExamined: 1000 and nReturned: 2. What is the best next step?

hard

A. Rewrite the query to return all documents in the collection

B. Increase the batch size to return more documents faster

C. Add an index on the query fields to reduce scanned documents

D. Ignore the explain output; it does not affect performance

Solution

1. Step 1: Analyze the explain stats

   High totalDocsExamined but low nReturned means many documents scanned unnecessarily.

2. Step 2: Choose optimization strategy

   Adding an index on query fields helps MongoDB scan fewer documents and improve speed.

3. Final Answer:

   Add an index on the query fields to reduce scanned documents -> Option C

4. Quick Check:

   Index reduces scanned docs, improves query [OK]

Hint: High scanned vs returned? Add index on query fields [OK]

Common Mistakes:

• Ignoring explain output and performance impact
• Increasing batch size without fixing scan issue
• Trying to return all documents unnecessarily