Migrar para o PyMongo async

Nesta página

Visão geral
Migrar do Motor
Alterações na assinatura do método
Migrar do PyMongo
Métodos assíncronos
Informações adicionais

Importante

O driver PyMongo Async é experimental e não deve ser usado em ambientes de produção. Classes, métodos e comportamentos descritos neste guia podem mudar antes da versão completa. Se você encontrar algum problema com o PyMongo Async, saiba como denunciá-lo na página Problemas e ajuda.

Visão geral

O driver PyMongo Async é uma unificação do PyMongo e da biblioteca Motor. Neste guia, você pode identificar as alterações que deve fazer para migrar um aplicação do PyMongo ou Motor para o driver do PyMongo Async.

Migrar do Motor

O driver PyMongo Async funciona de forma semelhante à biblioteca Motor, mas permite latência e taxa de transferência aprimoradas devido ao uso direto do Python Asyncio em vez de delegar trabalho a um pool de threads. Na maioria dos casos, você pode migrar diretamente os aplicativos Motor existentes para o PyMongo Async usando AsyncMongoClient no lugar de MotorClient e alterando as declarações de importação do aplicativo para importar de pymongo.

O exemplo a seguir mostra a diferença nas importações para usar um cliente para operações de leitura e escrita no Motor em comparação com o PyMongo Async:

# Motor client import
from motor.motor_asyncio import AsyncIOMotorClient
# PyMongo Async client import
from pymongo import AsyncMongoClient

Para ver uma lista dos métodos assíncronos disponíveis no driver do PyMongo Async, consulte a seção Métodos assíncronos no guia do PyMongo para o PyMongo Async.

A seção a seguir mostra as alterações na assinatura do método que você deve implementar em seu aplicação ao migrar do driver Motor para o PyMongo Async.

Alterações na assinatura do método

As seguintes assinaturas de método do Motor se comportam de forma diferente no driver PyMongo Async:

AsyncMongoClient.__init__() não aceita um parâmetro io_loop.
AsyncCursor.each() não existe no driver PyMongo Async.
MotorGridOut.stream_to_handler() não existe no driver PyMongo Async.
AsyncCursor.to_list(0) não é válido no driver PyMongo Async. Em vez disso, use to_list(None).
MongoClient é seguro para threads e pode ser usado por muitos threads, mas um AsyncMongoClient não é seguro para threads e só deve ser usado por um único loop de eventos.

Migrar do PyMongo

O driver PyMongo Async se comporta de forma semelhante ao PyMongo, mas todos os métodos que executam operações de rede são corrotinas e devem ser aguardadas. Para migrar do PyMongo para o PyMongo Async, você deve atualizar seu código das seguintes maneiras:

Substitua todos os usos de MongoClient por AsyncMongoClient.
Adicione a palavra-chave await a todas as chamadas de método assíncrono.
Se você chamar um método assíncrono dentro de uma função, marque a função como async.

As seções a seguir descrevem como implementar a API assíncrona.

Métodos assíncronos

As tabelas a seguir listam os métodos assíncronos disponíveis no driver PyMongo Async. Para chamar esses métodos, você deve await e chamá-los dentro de uma função async.

Métodos do cliente

Método

Exemplo

AsyncMongoClient()

from pymongo import AsyncMongoClient
async with AsyncMongoClient(...)

watch()

async with await client.watch(...) as stream:
   ...

server_info()

await client.server_info(...)

list_databases()

await client.list_databases()

list_database_names()

await client.list_database_names()

drop_database()

await client.drop_database(...)

Métodos do banco de dados

Método

Exemplo

watch()

async with await db.watch(...) as stream:
   ...

create_collection()

await db.create_collection(...)

aggregate()

async with await client.admin.aggregate(...) as cursor:
   ...

command()

await db.command(...)

cursor_command()

await db.cursor_command(...)

list_collections()

await db.list_collections()

list_collection_names()

await db.list_collection_names()

drop_collection()

await db.drop_collection(...)

validate_collection()

await db.validate_collection(...)

dereference()

await db.dereference(...)

Métodos de collection

Método

Exemplo

watch()

async with await collection.watch(...) as stream:
   ...

insert_one()

await collection.insert_one(...)

insert_many()

await collection.insert_many(...)

replace_one()

await collection.replace_one(...)

update_one()

await collection.update_one(...)

update_many()

await collection.update_many(...)

drop()

await collection.drop()

delete_one()

await collection.delete_one(...)

delete_many()

await collection.delete_many(...)

find_one()

await collection.find_one(...)

estimated_document_count()

await collection.estimated_document_count()

count_documents()

await collection.count_documents(...)

create_index()

await collection.create_index(...)

create_indexes()

await collection.create_indexes(...)

drop_index()

await collection.drop_index(...)

drop_indexes()

await collection.drop_indexes()

list_indexes()

await collection.list_indexes()

index_information()

await collection.index_information()

list_search_indexes()

await collection.list_search_indexes()

create_search_index()

await collection.create_search_index(...)

create_search_indexes()

await collection.create_search_indexes(...)

drop_search_index()

await collection.drop_search_index(...)

update_search_index()

await collection.update_search_index(...)

options()

await collection.options()

aggregate()

async for doc in await collection.aggregate(...):
   ...

aggregate_raw_batches()

async for batch in await collection.aggregate_raw_batches(...):
   ...

rename()

await collection.rename(...)

distinct()

await collection.distinct(...)

find_one_and_delete()

await collection.find_one_and_delete(...)

find_one_and_replace()

await collection.find_one_and_replace(...)

find_one_and_update()

await collection.find_one_and_update(...)

Informações adicionais

Para saber mais sobre Python assíncrono, consulte a documentação do Python Asyncio.

Voltar

Guias de atualização

Versões anteriores