Introducing Dragonfly Cloud! Learn More

Question: How does the $addToSet operator affect performance in MongoDB?


The $addToSet operator in MongoDB is used to add a value to an array only if the value does not already exist in the array, ensuring that each element in the array is unique. This operation can have implications on performance, particularly when dealing with large datasets or high-throughput environments.

How $addToSet Works

When you use $addToSet, MongoDB performs a few steps under the hood:

  1. It searches the existing array to check if the value to be added already exists.
  2. If the value doesn't exist, MongoDB adds it to the array.
  3. If the value already exists, the array remains unchanged.

This means that the performance impact of using $addToSet is related to how quickly MongoDB can perform step 1, i.e., searching the array for the existing value.

Factors Affecting Performance

  • Array Size: The larger the array, the longer it takes to search through it. Thus, using $addToSet on fields with large arrays can be slower.
  • Document Size: Larger documents (in terms of total size) can also slow down update operations because MongoDB has to find the document before it can update it.
  • Indexing: While you cannot directly index array elements to improve the performance of $addToSet, having indexes on other queried fields can help MongoDB locate the document faster, indirectly improving the performance of the update operation.
  • Write Concerns: The level of write concern specified (e.g., waiting for acknowledgments from multiple replicas) can also affect the perceived performance of your update operations.

Example Usage

db.collection.updateOne( { _id: 1 }, { $addToSet: { tags: "mongodb" } } );

In this example, the tag "mongodb" will be added to the tags array of the document with _id of 1, but only if "mongodb" isn't already in the array.

Best Practices

To mitigate potential performance issues with $addToSet, consider:

  • Keeping your arrays reasonably small and designing your schema to avoid very large arrays if possible.
  • Using compound indexes that include the fields involved in the query portion of your update operations, to speed up document location.
  • Monitoring your database's performance and considering schema changes if certain operations consistently lag.

In conclusion, while $addToSet is a powerful operator for maintaining unique arrays in MongoDB, understanding and mitigating its performance implications is key to maintaining a responsive and efficient application.

Was this content helpful?

White Paper

Free System Design on AWS E-Book

Download this early release of O'Reilly's latest cloud infrastructure e-book: System Design on AWS.

Free System Design on AWS E-Book

Start building today 

Dragonfly is fully compatible with the Redis ecosystem and requires no code changes to implement.