PyMongo

Introduction

Welcome to the documentation site for PyMongo, the official MongoDB driver for synchronous Python applications. Download it using pip or set up a runnable project by following our tutorial.

• Tutorial on how to connect to MongoDB and run common operations.

• API Reference

• Changelog

• Source Code

Take the Free Online Course Taught by MongoDB

	Using MongoDB with Python Learn the essentials of Python application development with MongoDB.

Compatibility

You can use the PyMongo driver to connect to deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB

• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Installation

You must install the PyMongo driver module to make it available to your Python application. We recommend using pip to install PyMongo.

PyMongo requires dnspython to support mongodb+srv:// connection strings and MongoDB Atlas. dnspython is automatically installed when installing or upgrading to the latest PyMongo version.

The following command demonstrates how you can install the latest version of the module using the command line:

$ python -m pip install pymongo

If you need to install a specific version of PyMongo, specify the version in your command. The following command shows how you can use pip to install PyMongo version 3.11:

$ python -m pip install pymongo==3.11

If you already have PyMongo installed and need to upgrade to the latest version, use the following pip command:

$ python -m pip install --upgrade pymongo

See Installation for more ways to install PyMongo.

Connect to MongoDB Atlas

You can use the following connection snippet to test your connection to your MongoDB deployment on Atlas:

from pymongo.mongo_client import MongoClient
from pymongo.server_api import ServerApi
# Replace the placeholder with your Atlas connection string
uri = "<connection string>"
# Set the Stable API version when creating a new client
client = MongoClient(uri, server_api=ServerApi('1'))
                          
# Send a ping to confirm a successful connection
try:
    client.admin.command('ping')
    print("Pinged your deployment. You successfully connected to MongoDB!")
except Exception as e:
    print(e)

This connection snippet uses the Stable API feature, which you can enable when using the PyMongo driver v3.12 and later to connect to MongoDB Server v5.0 and later. When you use this feature, you can update your driver or server without worrying about backward compatibility issues with any commands covered by the Stable API.

To learn more about the Stable API feature, see Stable API in the Server manual.

Connect to MongoDB Atlas Without the Stable API

If you are using a version of MongoDB or the driver that doesn't support the Stable API feature, you can use the following code snippet to test your connection to your MongoDB deployment on Atlas:

from pymongo.mongo_client import MongoClient
# Replace the placeholder with your Atlas connection string
uri = "<connection string>"
# Create a new client and connect to the server
client = MongoClient(uri)
# Send a ping to confirm a successful connection
try:
    client.admin.command('ping')
    print("Pinged your deployment. You successfully connected to MongoDB!")
except Exception as e:
    print(e)

Connect to MongoDB Atlas from AWS Lambda

To learn how to connect to Atlas from AWS Lambda, see the Manage Connections with AWS Lambda documentation.

Connect to a MongoDB Server on Your Local Machine

If you need to run a MongoDB server on your local machine for development purposes instead of using an Atlas cluster, you need to complete the following:

1. Download the Community or Enterprise version of MongoDB Server.

2. Install and configure MongoDB Server.

3. Start the server.

After you successfully start your MongoDB server, specify your connection string in your driver connection code.

If your MongoDB Server is running locally, you can use the connection string "mongodb://localhost:<port>" where <port> is the port number you configured your server to listen for incoming connections.

If you need to specify a different hostname or IP address, see our Server Manual entry on Connection Strings.

To test whether you can connect to your server, replace the connection string in the Connect to MongoDB Atlas code example and run it.

Compatibility