$rename operator for field names in MongoDB - Step-by-Step Execution

Concept Flow - $rename operator for field names

Start with original document

↓

Apply $rename operator

↓

Check each field in $rename

↓

Rename field if exists

↓

Create new field with old value

↓

Remove old field

↓

Return updated document

The $rename operator changes field names in a document by copying the value to a new field and removing the old field.

Execution Sample

MongoDB

db.collection.updateOne(
  { _id: 1 },
  { $rename: { "oldName": "newName" } }
)

This updates the document with _id 1 by renaming the field 'oldName' to 'newName'.

Execution Table

Step	Document State	Action	Result
1	{ _id: 1, oldName: "value", otherField: 123 }	Start with original document	Document unchanged
2	{ _id: 1, oldName: "value", otherField: 123 }	Check if 'oldName' exists	Yes, field found
3	{ _id: 1, oldName: "value", otherField: 123 }	Copy 'oldName' value to 'newName'	{ _id: 1, oldName: "value", newName: "value", otherField: 123 }
4	{ _id: 1, oldName: "value", newName: "value", otherField: 123 }	Remove 'oldName' field	{ _id: 1, newName: "value", otherField: 123 }
5	{ _id: 1, newName: "value", otherField: 123 }	Return updated document	Update complete

💡 All fields in $rename processed; document updated with renamed fields.

Variable Tracker

Variable	Start	After Step 3	After Step 4	Final
Document	{ _id: 1, oldName: "value", otherField: 123 }	{ _id: 1, oldName: "value", newName: "value", otherField: 123 }	{ _id: 1, newName: "value", otherField: 123 }	{ _id: 1, newName: "value", otherField: 123 }

Key Moments - 2 Insights

Why does the document temporarily have both 'oldName' and 'newName' fields during the rename?

Because $rename first copies the value to the new field before removing the old field, as shown in execution_table step 3 and 4.

What happens if the field to rename does not exist in the document?

No change occurs for that field; the document remains the same since $rename only affects existing fields (not shown in this trace but implied).

Visual Quiz - 3 Questions

Look at the execution_table, what is the document state after step 3?

A { _id: 1, newName: "value", otherField: 123 }

B { _id: 1, oldName: "value", newName: "value", otherField: 123 }

C { _id: 1, oldName: "value", otherField: 123 }

D { _id: 1, otherField: 123 }

💡 Hint

Check the 'Document State' column in execution_table row for step 3.

At which step is the 'oldName' field removed from the document?

A Step 4

B Step 2

C Step 3

D Step 5

💡 Hint

Look at the 'Action' column in execution_table to find when 'oldName' is removed.

If the document did not have 'oldName' field, what would happen?

A A new field 'newName' with null value would be added

B The document would be deleted

C The document would remain unchanged

D An error would occur

💡 Hint

Recall that $rename only affects existing fields; absence means no change.

Concept Snapshot

$rename operator syntax:
{ $rename: { "oldField": "newField" } }

Behavior:
- Copies value from oldField to newField
- Removes oldField
- Only affects existing fields

Use in update operations to rename fields in documents.

Full Transcript

The $rename operator in MongoDB updates documents by changing field names. It works by copying the value from the old field to a new field, then removing the old field. This process ensures the data is preserved under the new name. The execution steps start with the original document, check if the old field exists, copy its value to the new field, remove the old field, and finally return the updated document. If the old field does not exist, the document remains unchanged. This operator is useful for renaming fields without losing data.