$replaceRoot for restructuring in MongoDB

Introduction

$replaceRoot helps you change the shape of your data by replacing the whole document with a part of it. This makes it easier to work with nested information.

You want to flatten nested objects inside your documents to work with them directly.

You need to simplify the structure of your data for reporting or analysis.

You want to remove unnecessary outer layers of your documents to focus on important details.

You are preparing data for export and want a cleaner format.

You want to merge fields from a nested document into the top-level document.

Syntax

MongoDB

{ $replaceRoot: { newRoot: <document> } }

newRoot is the part of the document you want to keep as the new root.

You can use any field or expression that results in a document.

Examples

This replaces the whole document with the nested address object.

MongoDB

{ $replaceRoot: { newRoot: "$address" } }

This merges the contact object with a new field status and makes it the root.

MongoDB

{ $replaceRoot: { newRoot: { $mergeObjects: ["$contact", { status: "active" }] } } }

This replaces the document with the nested details inside profile.

MongoDB

{ $replaceRoot: { newRoot: "$profile.details" } }

Sample Program

This query takes the contact field from each users document and makes it the whole document in the output.

MongoDB

db.users.aggregate([
  { $replaceRoot: { newRoot: "$contact" } }
])

Important Notes

If the newRoot field does not exist, the document will be replaced with null.

You can combine $replaceRoot with other stages like $match or $project for more control.

Summary

$replaceRoot changes the whole document to a nested part you choose.

It helps simplify or flatten data structures.

Use it when you want to focus on a specific part of your documents.

Practice

1. What does the $replaceRoot stage do in a MongoDB aggregation pipeline?

easy

A. It groups documents by a specified key.

B. It filters documents based on a condition.

C. It replaces the entire document with the specified embedded document.

D. It sorts documents by a specified field.

Solution

1. Step 1: Understand the purpose of $replaceRoot

   $replaceRoot replaces the whole document with a specified nested document inside it.

2. Step 2: Compare with other stages

   Filtering, sorting, and grouping are done by $match, $sort, and $group respectively, not $replaceRoot.

3. Final Answer:

   It replaces the entire document with the specified embedded document. -> Option C

4. Quick Check:

   $replaceRoot changes document root [OK]

Hint: Remember: $replaceRoot swaps the whole document root [OK]

Common Mistakes:

• Confusing $replaceRoot with filtering or sorting stages
• Thinking it only modifies part of the document
• Assuming it adds fields instead of replacing

2. Which of the following is the correct syntax to use $replaceRoot to replace the root with the details field?

easy

A. { $replaceRoot: { newRoot: "$details" } }

B. { $replaceRoot: { root: "$details" } }

C. { $replaceRoot: { newRoot: details } }

D. { $replaceRoot: { newRoot: "$details" }, $match: {} }

Solution

1. Step 1: Recall correct $replaceRoot syntax

   The correct syntax requires newRoot with a string path starting with "$" to specify the field.

2. Step 2: Analyze options

   { $replaceRoot: { newRoot: "$details" } } uses newRoot: "$details" which is correct. { $replaceRoot: { root: "$details" } } uses wrong key root. { $replaceRoot: { newRoot: details } } misses quotes around field path. { $replaceRoot: { newRoot: "$details" }, $match: {} } adds an unrelated $match inside the same stage, which is invalid.

3. Final Answer:

   { $replaceRoot: { newRoot: "$details" } } -> Option A

4. Quick Check:

   Use newRoot: "$field" syntax [OK]

Hint: Use newRoot: "$fieldName" exactly [OK]

Common Mistakes:

• Omitting quotes around field path
• Using wrong key like 'root' instead of 'newRoot'
• Combining stages incorrectly

3. Given the collection documents:

{ "name": "Alice", "info": { "age": 30, "city": "NY" } }

What will be the output of this aggregation?

[{ $replaceRoot: { newRoot: "$info" } }]

medium

A. [{ "name": "Alice", "info": { "age": 30, "city": "NY" } }]

B. [{ "age": 30, "city": "NY" }]

C. [{ "info": { "age": 30, "city": "NY" } }]

D. [{ "age": 30 }]

Solution

1. Step 1: Understand $replaceRoot effect

   The stage replaces the whole document with the content of the info field.

2. Step 2: Apply to given document

   Original document has info as { "age": 30, "city": "NY" }, so output document is exactly that object.

3. Final Answer:

   [{ "age": 30, "city": "NY" }] -> Option B

4. Quick Check:

   Root replaced by info field content [OK]

Hint: Output matches the nested field content exactly [OK]

Common Mistakes:

• Expecting original fields to remain
• Confusing nested field with root
• Selecting wrong output format

4. You wrote this aggregation but it throws an error:

[{ $replaceRoot: { newRoot: info } }]

What is the error and how to fix it?

medium

A. Missing quotes around field path; fix with newRoot: "$info".

B. Wrong operator; use $setRoot instead of $replaceRoot.

C. Field info does not exist; add it first.

D. Aggregation pipeline must be an object, not an array.

Solution

1. Step 1: Identify syntax error in newRoot value

   The field path must be a string starting with "$" to indicate a field reference.

2. Step 2: Correct the syntax

   Change newRoot: info to newRoot: "$info" to fix the error.

3. Final Answer:

   Missing quotes around field path; fix with newRoot: "$info". -> Option A

4. Quick Check:

   Field paths need quotes and $ prefix [OK]

Hint: Always quote field paths with $ prefix [OK]

Common Mistakes:

• Omitting quotes around field names
• Confusing $replaceRoot with $setRoot
• Misunderstanding pipeline array structure

5. You have documents:

{ "user": { "id": 1, "name": "Bob" }, "score": 50 }

How do you write an aggregation pipeline using $replaceRoot to make the output documents only contain the user fields plus the score field at the root level?

hard

A. [{ $replaceRoot: { newRoot: "$score" } }]

B. [{ $replaceRoot: { newRoot: "$user" } }, { $addFields: { score: "$score" } }]

C. [{ $project: { user: 1, score: 1 } }]

D. [{ $replaceRoot: { newRoot: { $mergeObjects: ["$user", { score: "$score" }] } } }]

Solution

1. Step 1: Understand the goal

   We want to flatten user fields to root and keep score alongside.

2. Step 2: Use $mergeObjects inside $replaceRoot

   $mergeObjects combines user object and { score: "$score" } into one root document.

3. Step 3: Check options

   [{ $replaceRoot: { newRoot: { $mergeObjects: ["$user", { score: "$score" }] } } }] correctly merges and replaces root. [{ $replaceRoot: { newRoot: "$user" } }, { $addFields: { score: "$score" } }] tries to add fields after replacing root, but score is lost after first stage. [{ $project: { user: 1, score: 1 } }] only projects fields, not restructuring. [{ $replaceRoot: { newRoot: "$score" } }] replaces root with score only, losing user.

4. Final Answer:

   [{ $replaceRoot: { newRoot: { $mergeObjects: ["$user", { score: "$score" }] } } }] -> Option D

5. Quick Check:

   Use $mergeObjects to combine fields [OK]

Hint: Combine objects with $mergeObjects inside $replaceRoot [OK]

Common Mistakes:

• Replacing root with only one field losing others
• Trying to add fields after $replaceRoot without preserving data
• Using $project instead of restructuring