Unique Index | MongoDB Indexing Tutorial

Compound Index | MongoDB Indexing Tutorial

Index Performance | MongoDB Indexing Tutorial

Indexing Types | MongoDB Indexing Tutorial

List Indexes | MongoDB Indexing Tutorial

Create Index | MongoDB Indexing Tutorial

Key Takeaways

• A unique index in MongoDB ensures unique values for a specified field in a collection.
• Unique indexes prevent duplicate entries and can be enforced on single or multiple fields.
• Existing duplicate data in a collection will cause errors when applying a unique index.
• Setting the unique flag to true when creating an index enforces uniqueness.

What is a unique index in MongoDB?

A unique index in MongoDB is a powerful tool that ensures all values in a specific field of a collection are distinct. Beyond this, it enforces a level of data integrity that is critical when dealing with fields like usernames, email addresses, or other identifiers that should be unique across the dataset.

Popular ODMs like Mongoose still automatically create unique indexes at the schema level when you specify unique validation requirements in your models, streamlining database management and minimizing manual index creation.

How does a unique index work under the hood?

At its core, a unique index acts as a gatekeeper that disallows any insertion of duplicate values for the indexed field. When you create a MongoDB collection, a unique index is defaulted to the _id field, making sure each document is unique by its identifier.

A unique index is effective immediately: it blocks duplicate entries during insertion and validates uniqueness before and after any insertions or updates. If the field isn’t inherently unique due to existing data, attempting to apply a unique index will generate a DuplicateKey error.

If a field is missing in a document and a unique index is applied to that field, any other documents missing that field will also cause a DuplicateKey error. Essentially, the key must be either completely consistent or distinct across all documents.

How to create a unique index in MongoDB?

Creating a unique index is straightforward. You simply specify the unique flag as true when defining the index on the desired field:

db.people.createIndex({email: 1}, {unique: true})

This command indicates that the email field must be unique across all documents in the people collection. Attempting to add another document with an existing email will trigger the DuplicateKey error.

Bear in mind, if the collection already contains duplicate entries for the target field, the operation will not succeed. Instead, it will signal an error, requiring you to first resolve those conflicts.

For compound indexes — indices on multiple fields — enforce uniqueness like this:

db.people.createIndex({email: 1, user: 1}, {unique: true})

This ensures that the combination of email and user must be unique, allowing flexibility in scenarios where a single field might not suffice for distinction.

FAQ

Can I apply a unique index if my collection has duplicates?

No, attempting to create a unique index on a collection with existing duplicates will result in an error. You need to remove duplicates before applying the unique index.

What happens if I try to insert a duplicate entry?

Mongodb will reject the insertion attempt, returning a DuplicateKey error indicating a violation of the uniqueness constraint.

How do I handle missing fields with unique indexes?

Ensure that when you apply a unique index, the field is consistently filled across documents. An absent field is treated as a potential duplicate if another document is also missing the field.

Is it possible to create a unique index on multiple fields?

Yes, a unique compound index can be created on multiple fields to ensure unique values for a combination of fields rather than a single one.