Append item to MongoDB document array in PyMongo without re-insertion

Question

I am using MongoDB as the back-end database for Python web application (PyMongo + Bottle). Users can upload files and optionally 'tag' these files during upload. The tags are stored as a list within the document, per below:

{
    "_id" : ObjectId("561c199e038e42b10956e3fc"),
    "tags" : [ "tag1", "tag2", "tag3" ],
    "ref" : "4780"
}

I am trying to allow users to append new tags to any document. I came up with something like this:

def update_tags(ref, new_tag)
    # fetch desired document by ref key as dict
    document = dict(coll.find_one({'ref': ref}))
    # append new tag
    document['tags'].append(new_tag)
    # re-insert the document back into mongo
    coll.update(document)

(fyi; ref key is always unique. this could easily be _id as well.) It seems like there should be a way to just update the 'tags' value directly without pulling back the entire document and re-inserting. Am I missing something here?

Any thoughts are greatly appreciated :)

Sede · Accepted Answer · 2015-10-17 17:18:37Z

63

You don't need to use to retrieve the document first just use the .update method with the $push operator.

def update_tags(ref, new_tag):
    coll.update({'ref': ref}, {'$push': {'tags': new_tag}})

Since update is deprecated you should use the find_one_and_update or the update_one method if you are using pymongo 2.9 or newer

answered Oct 17, 2015 at 17:18

Sede

61.5k20 gold badges158 silver badges162 bronze badges

Sign up to request clarification or add additional context in comments.

7 Comments

langlauf.io Over a year ago

What is the difference between the two? Just the return value (the document vs an UpdateResult object) ? When do you use one or the other?

Gaurav Ojha Over a year ago

What happens if 'tags' field doesn't exist?

Sede Over a year ago

If tags field doesn't exist, it is created. @GauravOjha

Navi Over a year ago

Will it delete the old record?

Rylan Schaeffer Over a year ago

When I try appending a dictionary to a list, I get {TypeError}unhashable type: 'dict'. Why is PyMongo trying to hash the dictionary, and how do I append a dictionary to the list?

|

Nikhil Fulzele · Accepted Answer · 2017-10-12 05:47:52Z

11

You can simply do

1) If you want to append single entry

def update_tags(ref, new_tag):
    coll.update({'ref': ref}, {'$push': {'tags': new_tag}})

eg:

{
    "_id" : ObjectId("561c199e038e42b10956e3fc"),
    "tags" : [ "tag1", "tag2", "tag3" ],
    "ref" : "4780"
}
>> update_tags("4780", "tag4")
{'updatedExisting': True, u'nModified': 1, u'ok': 1, u'n': 1}
>> coll.find_one({"ref":"4780"})
{
    "_id" : ObjectId("561c199e038e42b10956e3fc"),
    "tags" : [ "tag1", "tag2", "tag3" , "tag4" ],
    "ref" : "4780"
}

2) If you want to append multiple entries

def update_tags(ref, new_tag):
    coll.update({'ref': ref}, {'$pushAll': {'tags': new_tag}}) #type of new_tag is list

eg:

{
    "_id" : ObjectId("561c199e038e42b10956e3fc"),
    "tags" : [ "tag1", "tag2", "tag3" ],
    "ref" : "4780"
}
>> update_tags("4780", ["tag5", "tag6", "tag7"])
{'updatedExisting': True, u'nModified': 1, u'ok': 1, u'n': 1}
>> coll.find_one({"ref":"4780"})
{
    "_id" : ObjectId("561c199e038e42b10956e3fc"),
    "tags" : [ "tag1", "tag2", "tag3" , "tag4" , "tag5", "tag6", "tag7" ],
    "ref" : "4780"
}

Note: If the key is not already present, then mongo will create new key.

answered Oct 12, 2017 at 5:47

Nikhil Fulzele

1111 silver badge2 bronze badges

2 Comments

Rajiv Sharma Over a year ago

pymongo.errors.WriteError: Unknown modifier: $pushAll

A.N.Tanvir Over a year ago

$pushAll won't work for appending multiple values to an array. Use $push with the $each modifier to append multiple values to the array field. {'$push': {'tags': { '$each': new_tags_array}}}

Kiluvya.A · Accepted Answer · 2017-09-15 02:05:23Z

9

Just to add to @ssytvane answer,and to answer @Guarav: you can add "upsert = True" if it does not exist:

def update_tags(ref, new_tag):
    coll.update({'ref': ref}, {'$push': {'tags': new_tag}}, upsert = True)

or

def update_tags(ref, new_tag):
    coll.update_one({'ref': ref}, {'$push': {'tags': new_tag}}, upsert = True)

answered Sep 15, 2017 at 2:05

Kiluvya.A

1612 silver badges7 bronze badges

2 Comments

Navi Over a year ago

what is ref here?

Zaraki Kenpachi Over a year ago

upsert (optional): When True, inserts a new document if no document matches the query. Defaults to False. api.mongodb.com/python/2.9/api/pymongo/…

ArminMz · Accepted Answer · 2020-03-30 14:03:14Z

5

There had been some good answers that are correct but in my opinion writing update_tags this way is better and more usable:

def update_tags(ref, *args):
    coll.update_one(ref, {'$push': {'tags': {'$each': args}}})

this way you can do both appending one tag or appending many tags:

>> update_tags(ref, 'tag5')

>> update_tags(ref, 'tag5', 'tag6')

>> list_of_new_tags = do_something_that_returns_list_of_tags()
>> update_tags(ref, *list_of_new_tags)

answered Mar 30, 2020 at 14:03

ArminMz

3456 silver badges10 bronze badges

Comments

mic · Accepted Answer · 2021-02-19 13:10:02Z

-1

You can use $push

collection_name.update_one({'ref': ref}, {'$push': {'tags': new_tag}})

You can update multiple arrays in a single query

collection_name.update_one({'ref': ref}, {'$push': {'field1': value1, 'filed2': value2}})

Values can be pushed to push like below.

{ $push: { <field1>: <value1>, ... } }

edited Feb 19, 2021 at 13:10

mic

4,5151 gold badge22 silver badges33 bronze badges

answered Jan 20, 2021 at 6:13

Basant Kumar

1371 silver badge3 bronze badges

Collectives™ on Stack Overflow

Append item to MongoDB document array in PyMongo without re-insertion

5 Answers 5

7 Comments

2 Comments

2 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

7 Comments

2 Comments

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related