Schema versioning strategies in MongoDB - Step-by-Step Execution

Concept Flow - Schema versioning strategies

Start: New Document Insert

↓

Check Document Schema Version

↓

Is Version Current?

No→Apply Migration Script

↓

Update Document to New Version

↓

Insert/Update Document

↓

End

When inserting or updating a document, check its schema version. If outdated, apply migration steps to update it before saving.

Execution Sample

MongoDB

db.collection.find({}).forEach(doc => {
  if(doc.schemaVersion < CURRENT_VERSION) {
    migrate(doc);
    db.collection.save(doc);
  }
});

This code checks each document's schema version and migrates it if outdated.

Execution Table

Step	Document ID	Schema Version Before	Condition (version < CURRENT_VERSION)	Action Taken	Schema Version After
1	doc1	1	1 < 3 (True)	Migrate doc1 schema	3
2	doc2	3	3 < 3 (False)	No action	3
3	doc3	2	2 < 3 (True)	Migrate doc3 schema	3
4	doc4	3	3 < 3 (False)	No action	3
5	-	-	-	All documents processed	-

💡 All documents checked; no more outdated versions found.

Variable Tracker

Variable	Start	After doc1	After doc2	After doc3	After doc4	Final
doc.schemaVersion	varies	doc1=3	doc2=3	doc3=3	doc4=3	all=3

Key Moments - 3 Insights

Why do we check the schema version before migrating?

Checking the schema version (see execution_table rows 1 and 2) ensures we only migrate documents that are outdated, avoiding unnecessary work.

What happens if a document already has the current schema version?

If the document's version equals the current version (rows 2 and 4), no migration is done and the document is left unchanged.

How do migration scripts update the document?

Migration scripts modify the document fields and set the schemaVersion to the current version, as shown in rows 1 and 3.

Visual Quiz - 3 Questions

Look at the execution_table, what is the schema version of doc3 after migration?

A 3

B 2

C 1

D Undefined

💡 Hint

Check the 'Schema Version After' column for doc3 in execution_table row 3.

At which step does the condition 'version < CURRENT_VERSION' become false?

A Step 1

B Step 3

C Step 2

D Step 5

💡 Hint

Look at the 'Condition' column in execution_table rows 1 and 2.

If CURRENT_VERSION changed to 4, what would happen to doc4 in the execution_table?

A No action, version already current

B Migrate doc4 schema to version 4

C Delete doc4

D Error occurs

💡 Hint

Compare doc4's version with new CURRENT_VERSION and see migration condition in execution_table.

Concept Snapshot

Schema Versioning in MongoDB:
- Store a 'schemaVersion' field in each document.
- On read/update, check if version < current.
- If outdated, run migration scripts to update.
- Save document with updated version.
- Ensures smooth schema evolution without downtime.

Full Transcript

Schema versioning strategies in MongoDB involve adding a schemaVersion field to each document. When documents are read or updated, their schemaVersion is checked against the current version. If the document's version is older, migration scripts run to update the document's structure and fields to the latest schema. After migration, the document's schemaVersion is updated and saved back to the database. This process ensures that all documents conform to the latest schema without requiring downtime or manual fixes. The execution table shows step-by-step how documents with different versions are checked and migrated if needed. Variables track the schemaVersion changes per document. Key moments clarify why version checks are important and how migrations work. The visual quiz tests understanding of version checks and migration effects. This strategy helps maintain data consistency and application stability as schemas evolve.

Practice

1. What is the main purpose of adding a schemaVersion field in MongoDB documents?

easy

A. To track changes in the document structure over time

B. To improve query performance automatically

C. To encrypt the document data

D. To store user authentication details

Solution

1. Step 1: Understand schemaVersion role

   The schemaVersion field is used to mark which version of the document structure is currently in use.

2. Step 2: Identify its purpose in schema versioning

   This helps developers know what format the data is in and apply necessary migrations when the schema changes.

3. Final Answer:

   To track changes in the document structure over time -> Option A

4. Quick Check:

   schemaVersion tracks structure changes = C [OK]

Hint: Remember schemaVersion marks document format version [OK]

Common Mistakes:

• Thinking schemaVersion improves query speed
• Confusing schemaVersion with encryption
• Assuming schemaVersion stores user info

2. Which of the following is the correct way to add a schemaVersion field with value 2 to a MongoDB document using an update query?

easy

A. db.collection.updateOne({ _id: id }, { $push: { schemaVersion: 2 } })

B. db.collection.updateOne({ _id: id }, { schemaVersion: 2 })

C. db.collection.updateOne({ _id: id }, { $set: { schemaVersion: 2 } })

D. db.collection.updateOne({ _id: id }, { $inc: { schemaVersion: 2 } })

Solution

1. Step 1: Recall MongoDB update syntax

   To set or update a field, use the $set operator with the new value.

2. Step 2: Check each option

   db.collection.updateOne({ _id: id }, { $set: { schemaVersion: 2 } }) correctly uses $set to assign schemaVersion: 2. Bare object updates lack an update operator (invalid), $push is for arrays, and $inc increments numbers.

3. Final Answer:

   db.collection.updateOne({ _id: id }, { $set: { schemaVersion: 2 } }) -> Option C

4. Quick Check:

   Use $set to update fields = A [OK]

Hint: Use $set to add or update fields in MongoDB [OK]

Common Mistakes:

• Forgetting to use $set operator
• Using $push for non-array fields
• Using $inc to set a fixed value

3. Given the following documents in a collection:

{ "_id": 1, "name": "Alice", "schemaVersion": 1 }

{ "_id": 2, "name": "Bob", "schemaVersion": 2 }

What will be the result of this query?

db.collection.find({ schemaVersion: { $lt: 2 } })

medium

A. [{ "_id": 1, "name": "Alice", "schemaVersion": 1 }, { "_id": 2, "name": "Bob", "schemaVersion": 2 }]

B. [{ "_id": 2, "name": "Bob", "schemaVersion": 2 }]

C. []

D. [{ "_id": 1, "name": "Alice", "schemaVersion": 1 }]

Solution

1. Step 1: Understand the query condition

   The query filters documents where schemaVersion is less than 2.

2. Step 2: Check each document against condition

   Document with schemaVersion 1 matches (1 < 2). Document with 2 does not (2 is not less than 2).

3. Final Answer:

   [{ "_id": 1, "name": "Alice", "schemaVersion": 1 }] -> Option D

4. Quick Check:

   schemaVersion < 2 returns only version 1 docs = D [OK]

Hint: Check numeric conditions carefully in queries [OK]

Common Mistakes:

• Including documents with schemaVersion equal to 2
• Returning empty result incorrectly
• Confusing $lt with $lte operator

4. You have a migration script to update documents from schemaVersion 1 to 2. The script uses:

db.collection.updateMany({ schemaVersion: 1 }, { $set: { schemaVersion: 2, newField: true } })

But after running, some documents still show schemaVersion 1. What is a likely cause?

medium

A. Documents were missing the schemaVersion field

B. The update query syntax is incorrect

C. The updateMany command does not support $set

D. The migration script ran on the wrong collection

Solution

1. Step 1: Analyze the update query filter

   The filter matches documents where schemaVersion equals 1 exactly.

2. Step 2: Consider documents missing the field

   If some documents lack the schemaVersion field, they won't match the filter and won't be updated.

3. Final Answer:

   Documents were missing the schemaVersion field -> Option A

4. Quick Check:

   Missing field means no match = B [OK]

Hint: Check if all docs have the field before filtering [OK]

Common Mistakes:

• Assuming updateMany syntax is wrong
• Believing $set is unsupported in updateMany
• Not verifying the collection name

5. You want to migrate documents from multiple schema versions to the latest version 3. Your current documents have schemaVersion 1 or 2. Which strategy best ensures all documents are updated correctly?

hard

A. Directly update all documents with version 1 or 2 to version 3 in one step

B. Run separate migration scripts: first update version 1 to 2, then update version 2 to 3

C. Delete all documents with version less than 3 and insert new ones

D. Ignore schemaVersion and update documents randomly

Solution

1. Step 1: Understand incremental migrations

   Updating schema versions step-by-step ensures each migration applies necessary changes safely.

2. Step 2: Evaluate options

   Run separate migration scripts: first update version 1 to 2, then update version 2 to 3 runs migrations in order: 1 to 2, then 2 to 3, preserving data integrity. Directly update all documents with version 1 or 2 to version 3 in one step risks skipping intermediate changes. Delete all documents with version less than 3 and insert new ones loses data. Ignore schemaVersion and update documents randomly is unsafe.

3. Final Answer:

   Run separate migration scripts: first update version 1 to 2, then update version 2 to 3 -> Option B

4. Quick Check:

   Incremental migrations keep data safe = A [OK]

Hint: Migrate stepwise through versions, not skipping steps [OK]

Common Mistakes:

• Trying to skip intermediate schema versions
• Deleting data instead of migrating
• Ignoring schemaVersion field