The Polymorphic and Schema Versioning Patterns
Learners will design a single collection that holds documents of different shapes using a type discriminator, and version schemas to enable gradual migrations.
The Polymorphic and Schema Versioning Patterns is a free MongoDB Academy lesson on CoddyKit — lesson 3 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the MongoDB Academy learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
Documents With Different Shapes
One of MongoDB's biggest advantages over SQL is that documents in the same collection do not need to share the same fields. This enables the Polymorphic Pattern — storing documents of fundamentally different types in a single collection. Think of a vehicles collection that holds cars, trucks, and motorcycles: all have make and year, but only cars have numberOfDoors and only motorcycles have hasSidecar.
// Polymorphic documents in one 'vehicles' collection
{ _id: ObjectId(), type: 'car', make: 'Toyota', year: 2022, numberOfDoors: 4, fuelType: 'hybrid' }
{ _id: ObjectId(), type: 'truck', make: 'Ford', year: 2021, payloadKg: 1200, hasTrailerHitch: true }
{ _id: ObjectId(), type: 'motorcycle', make: 'Honda', year: 2023, engineCC: 750, hasSidecar: false }The Type Discriminator Field
The key to the Polymorphic Pattern is a type discriminator field — a field (commonly named type, kind, or _type) that identifies which subtype a document represents. All application code and indexes can use this field to dispatch behaviour correctly. Index the discriminator field so queries filtering by type execute as IXSCAN rather than COLLSCAN.
// Index the type discriminator
db.vehicles.createIndex({ type: 1 })
// Query only cars
db.vehicles.find({ type: 'car', fuelType: 'hybrid' })
// Query all vehicles regardless of type
db.vehicles.find({ make: 'Toyota' })Polymorphism in Application Code
Application code handles polymorphic documents with a factory or strategy pattern: inspect the type field and delegate to the appropriate handler class or function. In Node.js/Mongoose, you can use discriminators — a built-in Mongoose feature that defines sub-schemas for each document type within a single collection, automatically setting and reading the discriminator key.
// Mongoose discriminators
const vehicleSchema = new mongoose.Schema({ make: String, year: Number })
const Vehicle = mongoose.model('Vehicle', vehicleSchema)
const Car = Vehicle.discriminator('car', new mongoose.Schema({
numberOfDoors: Number,
fuelType: String
}))
const Motorcycle = Vehicle.discriminator('motorcycle', new mongoose.Schema({
engineCC: Number,
hasSidecar: Boolean
}))
// Mongoose automatically sets __t discriminator field
await Car.create({ make: 'Toyota', year: 2022, numberOfDoors: 4, fuelType: 'hybrid' })When to Use Polymorphic vs Separate Collections
Use the Polymorphic Pattern when different subtypes share most of their fields and are queried together frequently. A single vehicles collection makes it easy to ask 'show all Toyota vehicles regardless of type'. Use separate collections when subtypes are almost entirely different, rarely queried together, or have vastly different indexing needs. Polymorphism trades simpler cross-type queries for slightly more complex per-type logic.
The Schema Versioning Pattern
Applications evolve and schemas change, but you cannot stop the world to migrate every document at once. The Schema Versioning Pattern adds a schema_version field to every document. Old documents have version 1 (or no version field, treated as v1), new documents have version 2. Application code checks the version and applies the appropriate transformation, enabling a gradual zero-downtime migration.
// Version 1 document (old shape)
{ _id: ObjectId(), name: 'Alice Smith', phone: '555-1234', schema_version: 1 }
// Version 2 document (new shape — phone normalised)
{
_id: ObjectId(),
name: 'Bob Jones',
contact: {
phone: '+15551234', // normalised E.164 format
email: 'bob@example.com'
},
schema_version: 2
}Reading With Version Awareness
When reading documents, check schema_version and handle each version appropriately in a transform layer. Version-agnostic code calls the transform function and always receives a canonical object. This decouples the application logic from the stored document shape and gives you time to migrate documents in the background without a hard cutover.
function normaliseUser(doc) {
if (!doc.schema_version || doc.schema_version === 1) {
// Upgrade v1 shape to canonical v2 shape in memory
return {
...doc,
contact: { phone: doc.phone, email: null },
schema_version: 2
}
}
return doc // already v2
}
const rawDoc = await db.collection('users').findOne({ _id: userId })
const user = normaliseUser(rawDoc)
console.log(user.contact.phone) // works for both v1 and v2 docsLazy Migration: Upgrade on Write
Lazy migration upgrades documents to the new schema as they are naturally accessed. When a document is read and transformed to v2 in memory, write the v2 shape back to the database. Over time, all active documents migrate without a bulk script. Inactive documents can be migrated by a background job. This approach is low-risk — no single large migration to coordinate or roll back.
async function getAndUpgradeUser(userId) {
const doc = await db.collection('users').findOne({ _id: userId })
const user = normaliseUser(doc)
// If doc was v1, write v2 shape back
if (!doc.schema_version || doc.schema_version < 2) {
await db.collection('users').replaceOne(
{ _id: userId },
{ ...user, schema_version: 2 }
)
}
return user
}Bulk Background Migration Script
For faster migration, run a background script that iterates over all v1 documents in batches using a cursor, transforms them, and writes back using bulkWrite(). Process documents in batches (e.g., 1,000 at a time) to avoid overwhelming the server. Run during off-peak hours and include a delay between batches to throttle impact on production traffic.
async function migrateUsers() {
const cursor = db.collection('users').find(
{ schema_version: { $lt: 2 } },
{ batchSize: 1000 }
)
let batch = []
for await (const doc of cursor) {
const upgraded = normaliseUser(doc)
batch.push({
replaceOne: {
filter: { _id: doc._id },
replacement: { ...upgraded, schema_version: 2 }
}
})
if (batch.length === 1000) {
await db.collection('users').bulkWrite(batch)
batch = []
}
}
if (batch.length > 0) await db.collection('users').bulkWrite(batch)
}Combining Polymorphic and Schema Versioning
These two patterns can work together. A polymorphic collection might have both a type discriminator (for subtype dispatch) and a schema_version (for evolutionary migration within each subtype). When documents of type 'car' gain a new required field in v2, the version field tracks which cars have been migrated and which still carry the old shape.
// A polymorphic, versioned document
{
_id: ObjectId(),
type: 'car',
schema_version: 2,
make: 'Toyota',
year: 2022,
numberOfDoors: 4,
// v2 added fuelType
fuelType: 'hybrid'
}Indexing Across Polymorphic Subtypes
Indexes in a polymorphic collection apply across all document types. A partial index (using partialFilterExpression) lets you index a field only for documents of a specific type — for example, indexing numberOfDoors only for car documents. This avoids indexing null/missing values for types that do not have the field, keeping the index small and efficient.
// Partial index: index numberOfDoors only for cars
db.vehicles.createIndex(
{ numberOfDoors: 1 },
{
partialFilterExpression: { type: 'car' },
name: 'car_doors_idx'
}
)
// Index engineCC only for motorcycles
db.vehicles.createIndex(
{ engineCC: 1 },
{ partialFilterExpression: { type: 'motorcycle' } }
)Anti-Pattern: Ignoring Schema Version
A common mistake is to update the schema without tracking versions, assuming all documents will be migrated before the new code deploys. In practice, migrations are rarely 100% complete at deploy time. Code that blindly reads a field that may not exist in older documents will throw null pointer errors or produce incorrect results. Always include a version check or a safe fallback when reading potentially-missing fields.
// DANGEROUS: assumes all docs have contact.email
const email = user.contact.email // TypeError if doc is v1
// SAFE: optional chaining with fallback
const email = user.contact?.email ?? user.email ?? nullQuick Check
Test your understanding of MongoDB & NoSQL Databases concepts from this lesson.
Lesson Recap
In this lesson you learned: the Polymorphic Pattern stores different document subtypes in one collection using a type discriminator field, enabling efficient cross-type queries and Mongoose discriminator support, the Schema Versioning Pattern tracks document shape evolution with a version field, enabling lazy or background migration without downtime, and partial indexes make polymorphic collections efficient by indexing fields only for the types that have them. Next up we cover the Outlier and Tree Structure Patterns.
Frequently asked questions
Is the “The Polymorphic and Schema Versioning Patterns” lesson free?
Yes — the full text of “The Polymorphic and Schema Versioning Patterns” is free to read here on the web, and the MongoDB Academy course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the MongoDB Academy course, upgrade to CoddyKit PRO.
What will I learn in “The Polymorphic and Schema Versioning Patterns”?
Learners will design a single collection that holds documents of different shapes using a type discriminator, and version schemas to enable gradual migrations. You practise MongoDB Academy with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start MongoDB Academy?
No prior experience is required. MongoDB Academy on CoddyKit is structured for beginners through advanced learners; this is — lesson 3 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “The Polymorphic and Schema Versioning Patterns” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this MongoDB Academy lesson?
Yes. Every MongoDB Academy lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- The Bucket and Computed Patterns
- The Extended Reference and Subset Patterns
- The Polymorphic and Schema Versioning Patterns
- The Outlier and Tree Structure Patterns