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.

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

To connect to a MongoDB Atlas cluster, use the Atlas connection string for your cluster:

import pymongo
# Replace the uri string with your MongoDB deployment's connection string.
conn_str = "mongodb+srv://<username>:<password>@<cluster-address>/test?retryWrites=true&w=majority"
# set a 5-second connection timeout
client = pymongo.MongoClient(conn_str, serverSelectionTimeoutMS=5000)
try:
    print(client.server_info())
except Exception:
    print("Unable to connect to the server.")

If the connection succeeds before a five-second timeout, you will see a dictionary containing information about the server you connected to.

If the connection fails, you should see the following message:

Unable to connect to the server.

For more information on the connection string, see the MongoDB Server Manual entry on Connection String URI Format.

Stable API

You can use the Stable API feature starting with MongoDB Server version 5.0 and PyMongo Driver version 3.12. When you use the Stable API feature, you can update your driver or server without worrying about backward compatibility issues with any commands covered by the Stable API.

To use this feature, construct a MongoDB client instance, specifying a version of the Stable API:

from pymongo.mongo_client import MongoClient
from pymongo.server_api import ServerApi
# Replace <connection string> with your MongoDB deployment's connection string.
conn_str = "<connection string>"
# Set the Stable API version on the client.
client = pymongo.MongoClient(conn_str, server_api=ServerApi('1'), serverSelectionTimeoutMS=5000)

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