MongoDB $addToSet Operator for Arrays

What is the $addToSet Operator?

$addToSet is an update operator in MongoDB used to add a value to an array only if the value does not already exist in the array.

This operator helps maintain unique elements within an array field, preventing duplicates without requiring manual checks.

• Adds a value to an array if it is not already present.
• Does nothing if the value already exists in the array.
• Operates atomically within a single update operation.

Syntax and Usage

The basic syntax for using $addToSet in an update operation is:

You specify the field to update and the value to add if it is not already present.

• db.collection.updateOne({filter}, {$addToSet: {field: value}})
• You can also add multiple values using $each inside $addToSet.

Examples

Here are practical examples demonstrating how to use $addToSet.

Best Practices

Follow these best practices when using $addToSet to maintain clean and efficient data.

• Use $addToSet to prevent duplicates instead of manual checks in application code.
• Combine $addToSet with $each to add multiple unique elements efficiently.
• Ensure the field you update is an array; otherwise, $addToSet will create an array with the value.
• Use indexes on array fields if you frequently query by array contents for better performance.

Common Mistakes

Avoid these common pitfalls when working with $addToSet.

• Using $addToSet on a non-array field can overwrite the field with an array.
• Expecting $addToSet to add duplicates; it only adds unique values.
• Not using $each when adding multiple elements, which results in adding a single array element instead of multiple.
• Confusing $addToSet with $push, which always adds elements regardless of duplicates.