How to Insert a Document Into a MongoDB Collection Using Python

Introduction

Mastering the art of inserting MongoDB documents and MongoDB databases using Python and its PyMongo library is a great way to streamline managing your MongoDB collections. Adding documents is a common task you’ll likely complete on a regular basis and accomplishing it in a straightforward way leads to a more productive and efficient day. If you already know the steps to insert MongoDB documents Python and insert into Mongo DB collection PyMongo, skip the details in this tutorial and proceed to Just the Code.

Prerequisites

• MongoDB – Install it. Next, in a terminal window, Test that it is installed and running correctly with the command mongo --version. You can also test it with the mongo command when you’re in the JavaScript interface Mongo shell.

• Python 3 – Download it. (Python 2 will be outdated soon. The examples in this tutorial require Python 3). Use the PIP package manager to install it:

• Create MongoDB document Python by creating a MongoDB database sample and collection. You will use the sample for inserting your collection and making API calls.

Import required modules and connect to MongoDB

• Import all the Python modules including the MongoClient class.

• Create a new MongoDB driver instance:

A PyMongo collection object is needed for API calls

• You’ll be making API calls using insert() and insert_one() with the PyMongo collection object. Use the mongo_client object instance for that. Declare instances first:

PyMongo 3.x insert_one() replaces insert()

• With PyMongo 3.x versions, the insert_one() replaces insert() for a single insertion, and insert_many() replaces insertMany() for inserting documents in bulk.

A DepreciationWarning is returned for outdated API call

• You’ll get the same type of DepreciationWarning error when you use the outdated insert() instead of insert_one(). Don’t worry about the attributes of the new method because that hasn’t changed.

Use insert_one() to add a Python dictionary to a MongoDB collection

• The parameters of insert_one() is where you’ll pass the Python dictionary for inserting a single document in a collection. In the example below, the API call is for a database instance attribute:

• Another way to make the API call is to use the method for the collection object and access col (the collection instance you created beforehand):

Between the two, the first suggestion is recommended because it’s more reliable when it comes to verifying that it’s inserted into the right collection. In addition, it’s likely to be easier for the computer and humans to read. However, it’s good to know that you have options.

PyMongo 3.x id string is not returned in the result object

• This is new to Pymongo 3.x versions. To return the document’s id in the result object, use inserted_id.:

Here’s an example of the outdated method used to access a MongoDB document’s _id

Create a Python dictionary to save time

• A Python dictionary saves you time in organizing your data for a MongoDB document. You can put MongoDB documents Python and organize everything in one place when you create a Python dictionary for a MongoDB document. This way, it will be more streamlined when you pass it for insertion.

Declare the MongoDB document’s Python dictionary

• Start with an empty dictionary. Use the update() method in Python’s dictionary for MongoDB field appending:

NOTE: Existing fields or keys will be updated to match the passed values if those fields or keys were already in the Python dictionary object.

Pass variables, functions, and objects into a Python dictionary

• Here’s a simple mathematical example of how easy it is for MongoDB fields in a document to be passed into a Python dictionary :

>NOTE: When you use the update() method, it’s important to use brackets ({}) around the updated values and keys.

• Another way to accomplish passing objects, variables, and functions is to do that at the same time you declare the dictionary. If you want, you can do this instead of the update() method.

Add the date and time in Python when you insert MongoDB documents

• Python’s PyMongo library’s datetime.now() method returns the current date and time in a datetime object when you insert a MongoDB document. Digits for the month, day, year, even seconds and microseconds can be returned if you like.

• Here’s an example of what a successful result looks like:

• Next, the datetime_now object is ready to pass to MongoDB document’s Python dictionary. You can append the datetime_now object if it already exists.

Insert the HTTP Message Body data into a MongoDB collection

• You can insert the HTTP Message Body string as a document into the MongoDB collection.

Use json.loads() in Python to handle the message data in the HTTP request

• There’s more you can pass to a Python dictionary. Let’s say, for example, you want to insert a document and you make a POST request to do that. Then, you can pass it to a Python dictionary.

• The loads() method from thejson library in Python can make a Python dictionary out of the HTTP message string. After that, you can insert the dictionary object into a MongoDB collection.

Conclusion

The PyMongo library has been updated. Insert MongoDB collection Python documents using the old Python 2 version method of insert() doesn’t work for Python 3.x versions. You’ll use the insert_one() method instead to insert into MongoDB collection PyMongo. If you forget and use the outdated insert) method, you’ll get aDepreciationWarning object returned. This tutorial explained how to insert MongoDB documents Python and insert into MongoDB collection PyMongo.

Just the Code

Here’s the entire Python script to insert MongoDB documents Python and insert into Mongo DB collection PyMongo.

An id that’s alphanumeric is shown at the end of a script that calls to insert a MongoDB document.

• Here’s an example of a successful terminal output.

MongoDB Compass Community GUI

• In the MongoDB Compass GUI, go to the document’s database and collection. You should see the document in which you used Python to insert into PyMongo.