Motor (Async Driver)

Introduction

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

• Tutorial on using Motor with Tornado

• Tutorial on using Motor with asyncio

• Motor Documentation

• Changelog

• Source Code

Follow the links below to read blog posts that describe specific use cases for the Motor driver:

• Porting From PyMongo To Motor

• Refactoring Tornado Coroutines

• All Motor articles on A. Jesse Jiryu Davis's blog

Installation

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

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

$ python -m pip install motor

For more information on requirements and other methods of installation, see the Motor Installation documentation.

Connect to MongoDB Atlas

You can use the following connection snippet to test your connection to your MongoDB deployment on Atlas using the asyncio asynchronous framework:

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

This connection snippet uses the Stable API feature, which you can enable when using the Motor driver v2.5 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:

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

If you are using the tornado asynchronous library, you can use the following code to connect to your MongoDB deployment:

import tornado
import motor
async def ping_server():
    # Replace the placeholder with your Atlas connection string
    uri = "<connection string>"
    # Set a 5-second connection timeout when creating a new client
    client = motor.motor_tornado.MotorClient(uri, serverSelectionTimeoutMS=5000)
    # Send a ping to confirm a successful connection
    try:
      await client.admin.command('ping')
      print("Pinged your deployment. You successfully connected to MongoDB!")
    except Exception as e:
      print(e)
tornado.ioloop.IOLoop.current().run_sync(ping_server)

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