How to Update Multiple Array Elements in mongodb
Asked Answered
A

16

247

I have a Mongo document which holds an array of elements.

I'd like to reset the .handled attribute of all objects in the array where .profile = XX.

The document is in the following form:

{
    "_id": ObjectId("4d2d8deff4e6c1d71fc29a07"),
    "user_id": "714638ba-2e08-2168-2b99-00002f3d43c0",
    "events": [{
            "handled": 1,
            "profile": 10,
            "data": "....."
        } {
            "handled": 1,
            "profile": 10,
            "data": "....."
        } {
            "handled": 1,
            "profile": 20,
            "data": "....."
        }
        ...
    ]
}

so, I tried the following:

.update({"events.profile":10},{$set:{"events.$.handled":0}},false,true)

However it updates only the first matched array element in each document. (That's the defined behaviour for $ - the positional operator.)

How can I update all matched array elements?

Anaesthesia answered 12/1, 2011 at 13:13 Comment(2)
Updating a subset or all array items has been added to mongodb 3.6: docs.mongodb.com/manual/reference/operator/update/…Plethora
be sure to check out arrayFilters and consider which query to use to make the update efficient. Check out the answer by Neil Lunn: https://mcmap.net/q/116103/-how-to-update-multiple-array-elements-in-mongodbPlethora
S
120

UPDATE: As of Mongo version 3.6, this answer is no longer valid as the mentioned issue was fixed and there are ways to achieve this. Please check other answers.


At this moment it is not possible to use the positional operator to update all items in an array. See JIRA http://jira.mongodb.org/browse/SERVER-1243

As a work around you can:

  • Update each item individually (events.0.handled events.1.handled ...) or...
  • Read the document, do the edits manually and save it replacing the older one (check "Update if Current" if you want to ensure atomic updates)
Site answered 12/1, 2011 at 14:9 Comment(7)
if you have similar problem, vote for this issue - jira.mongodb.org/browse/SERVER-1243Anaesthesia
I actually like the read document and save approach. But I used Couch before Mongo so that approach seems more natural since there is no query API for Couch, just a REST api for whole documentsConvection
Both of these approaches require quite high amount of memory, right? If there's a lot of documents which have to be searched, and have to load all of them (or the nested arrays) in order to update... + also a bit troublesome to implement if this has to be done asynchronously...Varices
@Ixx, that's when streams and bulk updates become your friend.Extinguish
All technical difficulties aside, it is rather astonishing that this feature is not available in MongoDB. This constraint takes away much freedom from customizing database schema.Buie
@javier-ferrero Updating a subset or all array items has been added to mongodb 3.6: docs.mongodb.com/manual/reference/operator/update/…Plethora
Neil Lunn https://mcmap.net/q/116103/-how-to-update-multiple-array-elements-in-mongodb answered this for version 3.6. Since this is a popular question it might be worth while to update this accepted answer with a referral to the answer by Neil Lunn.Plethora
S
150

With the release of MongoDB 3.6 ( and available in the development branch from MongoDB 3.5.12 ) you can now update multiple array elements in a single request.

This uses the filtered positional $[<identifier>] update operator syntax introduced in this version:

db.collection.update(
  { "events.profile":10 },
  { "$set": { "events.$[elem].handled": 0 } },
  { "arrayFilters": [{ "elem.profile": 10 }], "multi": true }
)

The "arrayFilters" as passed to the options for .update() or even .updateOne(), .updateMany(), .findOneAndUpdate() or .bulkWrite() method specifies the conditions to match on the identifier given in the update statement. Any elements that match the condition given will be updated.

Noting that the "multi" as given in the context of the question was used in the expectation that this would "update multiple elements" but this was not and still is not the case. It's usage here applies to "multiple documents" as has always been the case or now otherwise specified as the mandatory setting of .updateMany() in modern API versions.

NOTE Somewhat ironically, since this is specified in the "options" argument for .update() and like methods, the syntax is generally compatible with all recent release driver versions.

However this is not true of the mongo shell, since the way the method is implemented there ( "ironically for backward compatibility" ) the arrayFilters argument is not recognized and removed by an internal method that parses the options in order to deliver "backward compatibility" with prior MongoDB server versions and a "legacy" .update() API call syntax.

So if you want to use the command in the mongo shell or other "shell based" products ( notably Robo 3T ) you need a latest version from either the development branch or production release as of 3.6 or greater.

See also positional all $[] which also updates "multiple array elements" but without applying to specified conditions and applies to all elements in the array where that is the desired action.

Also see Updating a Nested Array with MongoDB for how these new positional operators apply to "nested" array structures, where "arrays are within other arrays".

IMPORTANT - Upgraded installations from previous versions "may" have not enabled MongoDB features, which can also cause statements to fail. You should ensure your upgrade procedure is complete with details such as index upgrades and then run

   db.adminCommand( { setFeatureCompatibilityVersion: "3.6" } )

Or higher version as is applicable to your installed version. i.e "4.0" for version 4 and onwards at present. This enabled such features as the new positional update operators and others. You can also check with:

   db.adminCommand( { getParameter: 1, featureCompatibilityVersion: 1 } )

To return the current setting

Scoot answered 5/9, 2017 at 11:43 Comment(7)
The accepted answer should be updated and refer to this answer.Plethora
What is elem?Wellthoughtof
This is correct. Note that RoboMongo doesn't support arrayFilters yet, so running update via CLI. #48323334Afferent
thank you, Neil, especially for the IMPORTANT section, exactly what I neededMoneybags
this code returns ERROR in pymongo. tehre is error: raise TypeError("%s must be True or False" % (option,)) TypeError: upsert must be True or FalseTransient
I'm confused.. How does the arrayFilter statement know that 'elem' refers to the events array?Radioactivate
@Radioactivate I think this is what's meant by "filtered positional $[<identifier>]" (see the link there). Here <identifier> is elem.Yabber
S
120

UPDATE: As of Mongo version 3.6, this answer is no longer valid as the mentioned issue was fixed and there are ways to achieve this. Please check other answers.


At this moment it is not possible to use the positional operator to update all items in an array. See JIRA http://jira.mongodb.org/browse/SERVER-1243

As a work around you can:

  • Update each item individually (events.0.handled events.1.handled ...) or...
  • Read the document, do the edits manually and save it replacing the older one (check "Update if Current" if you want to ensure atomic updates)
Site answered 12/1, 2011 at 14:9 Comment(7)
if you have similar problem, vote for this issue - jira.mongodb.org/browse/SERVER-1243Anaesthesia
I actually like the read document and save approach. But I used Couch before Mongo so that approach seems more natural since there is no query API for Couch, just a REST api for whole documentsConvection
Both of these approaches require quite high amount of memory, right? If there's a lot of documents which have to be searched, and have to load all of them (or the nested arrays) in order to update... + also a bit troublesome to implement if this has to be done asynchronously...Varices
@Ixx, that's when streams and bulk updates become your friend.Extinguish
All technical difficulties aside, it is rather astonishing that this feature is not available in MongoDB. This constraint takes away much freedom from customizing database schema.Buie
@javier-ferrero Updating a subset or all array items has been added to mongodb 3.6: docs.mongodb.com/manual/reference/operator/update/…Plethora
Neil Lunn https://mcmap.net/q/116103/-how-to-update-multiple-array-elements-in-mongodb answered this for version 3.6. Since this is a popular question it might be worth while to update this accepted answer with a referral to the answer by Neil Lunn.Plethora
A
76

What worked for me was this:

db.collection.find({ _id: ObjectId('4d2d8deff4e6c1d71fc29a07') })
  .forEach(function (doc) {
    doc.events.forEach(function (event) {
      if (event.profile === 10) {
        event.handled=0;
      }
    });
    db.collection.save(doc);
  });

I think it's clearer for mongo newbies and anyone familiar with JQuery & friends.

Aintab answered 15/12, 2013 at 23:32 Comment(6)
I'm using db.posts.find({ 'permalink':permalink }).forEach( function(doc) {... and I'm getting Oops.. TypeError: Object # has no method 'forEach'Coyne
@Coyne could be outdated mongodb version? The doc is clear on how to apply forEach function on a cursor but does not state since which version is supported. docs.mongodb.org/manual/reference/method/cursor.forEachAintab
@Coyne try db.posts.find(...).toArray().forEach(...)Statue
Can we not do this without using Javascript? I want to perform this update directly from a mongo shell without using Javascript API.Duodenitis
@DazzleR that JS code runs in the Mongo shell. Just copy/paste.Aintab
Can you please write this query in mongodb driver for java or with spring-data-mongodb? Thanks, krisUwton
M
18

This can also be accomplished with a while loop which checks to see if any documents remain that still have subdocuments that have not been updated. This method preserves the atomicity of your updates (which many of the other solutions here do not).

var query = {
    events: {
        $elemMatch: {
            profile: 10,
            handled: { $ne: 0 }
        }
    }
};

while (db.yourCollection.find(query).count() > 0) {
    db.yourCollection.update(
        query,
        { $set: { "events.$.handled": 0 } },
        { multi: true }
    );
}

The number of times the loop is executed will equal the maximum number of times subdocuments with profile equal to 10 and handled not equal to 0 occur in any of the documents in your collection. So if you have 100 documents in your collection and one of them has three subdocuments that match query and all the other documents have fewer matching subdocuments, the loop will execute three times.

This method avoids the danger of clobbering other data that may be updated by another process while this script executes. It also minimizes the amount of data being transferred between client and server.

Merrymaker answered 19/1, 2016 at 21:38 Comment(0)
A
15

This does in fact relate to the long standing issue at http://jira.mongodb.org/browse/SERVER-1243 where there are in fact a number of challenges to a clear syntax that supports "all cases" where mutiple array matches are found. There are in fact methods already in place that "aid" in solutions to this problem, such as Bulk Operations which have been implemented after this original post.

It is still not possible to update more than a single matched array element in a single update statement, so even with a "multi" update all you will ever be able to update is just one mathed element in the array for each document in that single statement.

The best possible solution at present is to find and loop all matched documents and process Bulk updates which will at least allow many operations to be sent in a single request with a singular response. You can optionally use .aggregate() to reduce the array content returned in the search result to just those that match the conditions for the update selection:

db.collection.aggregate([
    { "$match": { "events.handled": 1 } },
    { "$project": {
        "events": {
            "$setDifference": [
               { "$map": {
                   "input": "$events",
                   "as": "event",
                   "in": {
                       "$cond": [
                           { "$eq": [ "$$event.handled", 1 ] },
                           "$$el",
                           false
                       ]
                   }
               }},
               [false]
            ]
        }
    }}
]).forEach(function(doc) {
    doc.events.forEach(function(event) {
        bulk.find({ "_id": doc._id, "events.handled": 1  }).updateOne({
            "$set": { "events.$.handled": 0 }
        });
        count++;

        if ( count % 1000 == 0 ) {
            bulk.execute();
            bulk = db.collection.initializeOrderedBulkOp();
        }
    });
});

if ( count % 1000 != 0 )
    bulk.execute();

The .aggregate() portion there will work when there is a "unique" identifier for the array or all content for each element forms a "unique" element itself. This is due to the "set" operator in $setDifference used to filter any false values returned from the $map operation used to process the array for matches.

If your array content does not have unique elements you can try an alternate approach with $redact:

db.collection.aggregate([
    { "$match": { "events.handled": 1 } },
    { "$redact": {
        "$cond": {
            "if": {
                "$eq": [ { "$ifNull": [ "$handled", 1 ] }, 1 ]
            },
            "then": "$$DESCEND",
            "else": "$$PRUNE"
        }
    }}
])

Where it's limitation is that if "handled" was in fact a field meant to be present at other document levels then you are likely going to get unexepected results, but is fine where that field appears only in one document position and is an equality match.

Future releases ( post 3.1 MongoDB ) as of writing will have a $filter operation that is simpler:

db.collection.aggregate([
    { "$match": { "events.handled": 1 } },
    { "$project": {
        "events": {
            "$filter": {
                "input": "$events",
                "as": "event",
                "cond": { "$eq": [ "$$event.handled", 1 ] }
            }
        }
    }}
])

And all releases that support .aggregate() can use the following approach with $unwind, but the usage of that operator makes it the least efficient approach due to the array expansion in the pipeline:

db.collection.aggregate([
    { "$match": { "events.handled": 1 } },
    { "$unwind": "$events" },
    { "$match": { "events.handled": 1 } },
    { "$group": {
        "_id": "$_id",
        "events": { "$push": "$events" }
    }}        
])

In all cases where the MongoDB version supports a "cursor" from aggregate output, then this is just a matter of choosing an approach and iterating the results with the same block of code shown to process the Bulk update statements. Bulk Operations and "cursors" from aggregate output are introduced in the same version ( MongoDB 2.6 ) and therefore usually work hand in hand for processing.

In even earlier versions then it is probably best to just use .find() to return the cursor, and filter out the execution of statements to just the number of times the array element is matched for the .update() iterations:

db.collection.find({ "events.handled": 1 }).forEach(function(doc){ 
    doc.events.filter(function(event){ return event.handled == 1 }).forEach(function(event){
        db.collection.update({ "_id": doc._id },{ "$set": { "events.$.handled": 0 }});
    });
});

If you are aboslutely determined to do "multi" updates or deem that to be ultimately more efficient than processing multiple updates for each matched document, then you can always determine the maximum number of possible array matches and just execute a "multi" update that many times, until basically there are no more documents to update.

A valid approach for MongoDB 2.4 and 2.2 versions could also use .aggregate() to find this value:

var result = db.collection.aggregate([
    { "$match": { "events.handled": 1 } },
    { "$unwind": "$events" },
    { "$match": { "events.handled": 1 } },
    { "$group": {
        "_id": "$_id",
        "count": { "$sum": 1 }
    }},
    { "$group": {
        "_id": null,
        "count": { "$max": "$count" }
    }}
]);

var max = result.result[0].count;

while ( max-- ) {
    db.collection.update({ "events.handled": 1},{ "$set": { "events.$.handled": 0 }},{ "multi": true })
}

Whatever the case, there are certain things you do not want to do within the update:

  1. Do not "one shot" update the array: Where if you think it might be more efficient to update the whole array content in code and then just $set the whole array in each document. This might seem faster to process, but there is no guarantee that the array content has not changed since it was read and the update is performed. Though $set is still an atomic operator, it will only update the array with what it "thinks" is the correct data, and thus is likely to overwrite any changes occurring between read and write.

  2. Do not calculate index values to update: Where similar to the "one shot" approach you just work out that position 0 and position 2 ( and so on ) are the elements to update and code these in with and eventual statement like:

    { "$set": {
        "events.0.handled": 0,
        "events.2.handled": 0
    }}
    

    Again the problem here is the "presumption" that those index values found when the document was read are the same index values in th array at the time of update. If new items are added to the array in a way that changes the order then those positions are not longer valid and the wrong items are in fact updated.

So until there is a reasonable syntax determined for allowing multiple matched array elements to be processed in single update statement then the basic approach is to either update each matched array element in an indvidual statement ( ideally in Bulk ) or essentially work out the maximum array elements to update or keep updating until no more modified results are returned. At any rate, you should "always" be processing positional $ updates on the matched array element, even if that is only updating one element per statement.

Bulk Operations are in fact the "generalized" solution to processing any operations that work out to be "multiple operations", and since there are more applications for this than merely updating mutiple array elements with the same value, then it has of course been implemented already, and it is presently the best approach to solve this problem.

Airmail answered 18/10, 2015 at 0:58 Comment(0)
C
14

First: your code did not work because you were using the positional operator $ which only identifies an element to update in an array but does not even explicitly specify its position in the array.

What you need is the filtered positional operator $[<identifier>]. It would update all elements that match an array filter condition.

Solution:

db.collection.update({"events.profile":10}, { $set: { "events.$[elem].handled" : 0 } },
   {
     multi: true,
     arrayFilters: [ { "elem.profile": 10 } ]
})

Visit mongodb doc here

What the code does:

  1. {"events.profile":10} filters your collection and return the documents matching the filter

  2. The $set update operator: modifies matching fields of documents it acts on.

  3. {multi:true} It makes .update() modifies all documents matching the filter hence behaving like updateMany()

  4. { "events.$[elem].handled" : 0 } and arrayFilters: [ { "elem.profile": 10 } ] This technique involves the use of the filtered positional array with arrayFilters. the filtered positional array here $[elem] acts as a placeholder for all elements in the array fields that match the conditions specified in the array filter.

Array filters

Cashbox answered 14/3, 2020 at 14:45 Comment(0)
M
11

You can update all elements in MongoDB

db.collectioname.updateOne(
{ "key": /vikas/i },
{ $set: { 
 "arr.$[].status" : "completed"
} }
)

It will update all the "status" value to "completed" in the "arr" Array

If Only one document

db.collectioname.updateOne(
 { key:"someunique", "arr.key": "myuniq" },
 { $set: { 
   "arr.$.status" : "completed", 
   "arr.$.msgs":  {
                "result" : ""
        }
   
 } }
)

But if not one and also you don't want all the documents in the array to update then you need to loop through the element and inside the if block

db.collectioname.find({findCriteria })
  .forEach(function (doc) {
    doc.arr.forEach(function (singlearr) {
      if (singlearr check) {
        singlearr.handled =0
      }
    });
    db.collection.save(doc);
  });
Metcalfe answered 22/6, 2020 at 10:25 Comment(1)
$[] working. thnxRavi
T
8

I'm amazed this still hasn't been addressed in mongo. Overall mongo doesn't seem to be great when dealing with sub-arrays. You can't count sub-arrays simply for example.

I used Javier's first solution. Read the array into events then loop through and build the set exp:

var set = {}, i, l;
for(i=0,l=events.length;i<l;i++) {
  if(events[i].profile == 10) {
    set['events.' + i + '.handled'] = 0;
  }
}

.update(objId, {$set:set});

This can be abstracted into a function using a callback for the conditional test

Tum answered 2/6, 2013 at 13:54 Comment(2)
Thanks for this! Can't believe this feature still isn't natively supported! Used this to increment every item of a subarray, for others reading... to update every item just remove the if statement.Pallaten
This is not a safe solution. If a record gets added while you are running the update, you will corrupt your data.Compliant
K
7

The thread is very old, but I came looking for answer here hence providing new solution.

With MongoDB version 3.6+, it is now possible to use the positional operator to update all items in an array. See official documentation here.

Following query would work for the question asked here. I have also verified with Java-MongoDB driver and it works successfully.

.update(   // or updateMany directly, removing the flag for 'multi'
   {"events.profile":10},
   {$set:{"events.$[].handled":0}},  // notice the empty brackets after '$' opearor
   false,
   true
)

Hope this helps someone like me.

Kandacekandahar answered 19/6, 2019 at 5:29 Comment(0)
C
4

I've been looking for a solution to this using the newest driver for C# 3.6 and here's the fix I eventually settled on. The key here is using "$[]" which according to MongoDB is new as of version 3.6. See https://docs.mongodb.com/manual/reference/operator/update/positional-all/#up.S[] for more information.

Here's the code:

{
   var filter = Builders<Scene>.Filter.Where(i => i.ID != null);
   var update = Builders<Scene>.Update.Unset("area.$[].discoveredBy");
   var result = collection.UpdateMany(filter, update, new UpdateOptions { IsUpsert = true});
}

For more context see my original post here: Remove array element from ALL documents using MongoDB C# driver

Cableway answered 6/6, 2018 at 0:27 Comment(0)
M
3

$[] operator selects all nested array ..You can update all array items with '$[]'

.update({"events.profile":10},{$set:{"events.$[].handled":0}},false,true)

Reference

Malley answered 12/8, 2019 at 11:24 Comment(2)
Can you please explain why you include the "false,true" at the end here? I can't find it in the documentation.Avon
Wrong answer the all positional operator $[] just updates all fields in the specified array. What works is the filtered positional operator $[identifier] that operators on array fields that match the specified conditions. Should be used with arrayFilters Refrence: docs.mongodb.com/manual/release-notes/3.6/#arrayfilters and docs.mongodb.com/manual/reference/operator/update/…Cashbox
M
2

Please be aware that some answers in this thread suggesting use $[] is WRONG.

db.collection.update(
   {"events.profile":10},
   {$set:{"events.$[].handled":0}},
   {multi:true}
)

The above code will update "handled" to 0 for all elements in "events" array, regardless of its "profile" value. The query {"events.profile":10} is only to filter the whole document, not the documents in the array. In this situation it is a must to use $[elem] with arrayFilters to specify the condition of array items so Neil Lunn's answer is correct.

Motorbike answered 19/8, 2019 at 2:22 Comment(0)
B
0

Actually, The save command is only on instance of Document class. That have a lot of methods and attribute. So you can use lean() function to reduce work load. Refer here. https://hashnode.com/post/why-are-mongoose-mongodb-odm-lean-queries-faster-than-normal-queries-cillvawhq0062kj53asxoyn7j

Another problem with save function, that will make conflict data in with multi-save at a same time. Model.Update will make data consistently. So to update multi items in array of document. Use your familiar programming language and try something like this, I use mongoose in that:

User.findOne({'_id': '4d2d8deff4e6c1d71fc29a07'}).lean().exec()
  .then(usr =>{
    if(!usr)  return
    usr.events.forEach( e => {
      if(e && e.profile==10 ) e.handled = 0
    })
    User.findOneAndUpdate(
      {'_id': '4d2d8deff4e6c1d71fc29a07'},
      {$set: {events: usr.events}},
      {new: true}
    ).lean().exec().then(updatedUsr => console.log(updatedUsr))
})
Blowzed answered 29/7, 2017 at 18:35 Comment(0)
I
0

Update array field in multiple documents in mongo db.

Use $pull or $push with update many query to update array elements in mongoDb.

Notification.updateMany(
    { "_id": { $in: req.body.notificationIds } },
    {
        $pull: { "receiversId": req.body.userId }
    }, function (err) {
        if (err) {
            res.status(500).json({ "msg": err });
        } else {
            res.status(200).json({
                "msg": "Notification Deleted Successfully."
            });
        }
    });
Intuitionism answered 15/10, 2019 at 7:19 Comment(0)
B
0

if you want to update array inside array

    await Booking.updateOne(
      {
        userId: req.currentUser?.id,
        cart: {
          $elemMatch: {
            id: cartId,
            date: date,
            //timeSlots: {
              //$elemMatch: {
                //id: timeSlotId,
              //},
            //},
          },
        },
      },
      {
        $set: {
          version: booking.version + 1,
          'cart.$[i].timeSlots.$[j].spots': spots,
        },
      },
      {
        arrayFilters: [
          {
            'i.id': cartId,
          },
          {
            'j.id': timeSlotId,
          },
        ],
        new: true,
      }
    );
Biparietal answered 11/3, 2022 at 12:31 Comment(0)
D
-1

I tried the following and its working fine.

.update({'events.profile': 10}, { '$set': {'events.$.handled': 0 }},{ safe: true, multi:true }, callback function);

// callback function in case of nodejs

Destine answered 4/9, 2017 at 16:45 Comment(3)
This code just update the first matched item in the array. Wrong answer.Depredate
It works for v2.6. You may be at a older version? Here's its doc docs.mongodb.com/manual/reference/method/db.collection.update/…Manner
The docs for the positional update operator states that it only applies to the first match docs.mongodb.com/v2.6/reference/operator/update/positional/…Cammiecammy

© 2022 - 2024 — McMap. All rights reserved.