Skip to main content

Update schemas validation

Updating schema validation rules in MongoDB is a common operation, especially as your application evolves and requires more complex data structures or validation logic. You can update the schema validation rules for an existing collection using the collMod command or its equivalent in various MongoDB drivers.

Using collMod Command

The collMod command allows you to modify various collection options, including its validation rules. Here's an example that updates the schema validation for a collection named users:

db.runCommand({
collMod: "users",
validator: {
$jsonSchema: {
bsonType: "object",
required: ["name", "email", "status"],
properties: {
name: {
bsonType: "string",
description: "Name must be a string"
},
email: {
bsonType: "string",
description: "Email must be a string"
},
status: {
enum: ["Active", "Inactive"],
description: "Status must be either Active or Inactive"
}
}
}
},
validationLevel: "strict",
validationAction: "error"
});

In this example, a new required field status is added to the schema, and its possible values are restricted to "Active" or "Inactive".

Using MongoDB Drivers

Most MongoDB drivers provide a method to modify collection options, including validation rules. Here's how you might do it using Node.js and the MongoDB Node.js driver:

const { MongoClient } = require("mongodb");

async function updateSchema() {
const client = await MongoClient.connect("mongodb://localhost:27017/");
const db = client.db("testDB");

await db.command({
collMod: "users",
validator: {
$jsonSchema: {
bsonType: "object",
required: ["name", "email", "status"],
// ... (rest of the schema)
}
},
validationLevel: "strict",
validationAction: "error"
});

client.close();
}

updateSchema().catch(console.error);

Considerations

  1. Backward Compatibility: When updating schema validation rules, consider how the changes will affect existing documents that may not comply with the new schema.

  2. Validation Level and Action: You can also update the validationLevel and validationAction settings when you update the schema. Make sure to set these according to your requirements.

  3. Testing: Before applying changes to a production database, test the new schema validation rules in a development environment to ensure they behave as expected.

  4. Data Migration: In some cases, you may need to migrate existing data to conform to the new schema. Plan this carefully to minimize downtime or data inconsistencies.