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

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

If you are using the asyncio asynchronous framework, you can use the following code to connect:

import asyncio
import motor.motor_asyncio
async def get_server_info():
    # replace this with your MongoDB connection string
    conn_str = "<your MongoDB Atlas connection string>"
    # set a 5-second connection timeout
    client = motor.motor_asyncio.AsyncIOMotorClient(conn_str, serverSelectionTimeoutMS=5000)
    try:
        print(await client.server_info())
    except Exception:
        print("Unable to connect to the server.")
loop = asyncio.get_event_loop()
loop.run_until_complete(get_server_info())

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

import tornado
import motor
async def get_server_info():
    # replace this with your MongoDB connection string
    conn_str = "<your MongoDB Atlas connection string>"
    # set a 5-second connection timeout
    client = motor.motor_tornado.MotorClient(conn_str, serverSelectionTimeoutMS=5000)
    try:
        print(await client.server_info())
    except Exception:
        print("Unable to connect to the server.")
tornado.ioloop.IOLoop.current().run_sync(get_server_info)

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.

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