Crea un MongoClient

Overview

Para conectarte a una implementación de MongoDB, necesitas dos cosas:

• Un URI de conexión, también conocido como cadena de conexión, que le indica a PyMongo a qué implementación de MongoDB debes conectarse.

• Un objeto MongoClient, que crea la conexión a la implementación de MongoDB y permite realizar operaciones en ella.

También puede utilizar cualquiera de estos componentes para personalizar la forma en que PyMongo se comporta mientras está conectado a MongoDB.

Esta guía le muestra cómo crear una cadena de conexión y utilizar una MongoClient objeto para conectarse a MongoDB.

URI de conexión

Una cadena de conexión estándar incluye los siguientes componentes:

Para obtener más información sobre cómo crear una cadena de conexión, consulte Cadenas de conexión en la documentación del servidor MongoDB.

MongoClient

Para crear una conexión a MongoDB, pasa un URI de conexión como un string al constructor MongoClient. En el siguiente ejemplo, el controlador utiliza un URI de conexión de muestra para conectarse a una instancia de MongoDB en el puerto 27017 de localhost:

from pymongo import MongoClient
uri = "mongodb://localhost:27017/"
client = MongoClient(uri)

Si se está trabajando con una aplicación asincrónica, se debe usar la clase AsyncMongoClient. El siguiente ejemplo muestra cómo crear un objeto AsyncMongoClient:

from pymongo import AsyncMongoClient
uri = "mongodb://localhost:27017/"
client = AsyncMongoClient(uri)

La siguiente tabla describe los parámetros posicionales que acepta el constructor MongoClient(). Todos los parámetros son opcionales.

También puede pasar argumentos de palabras clave al constructor MongoClient() para especificar parámetros opcionales. Para una lista completa de argumentos de palabras clave, consulte la clase MongoClient en la documentación de la API.

Ejecución concurrente

Las siguientes secciones describen el soporte de PyMongo para mecanismos de ejecución concurrente.

# Each process creates its own instance of MongoClient.
def func():
    db = pymongo.MongoClient().mydb
    # Do something with db.
proc = multiprocessing.Process(target=func)
proc.start()

Sugerencias de tipo

Si la aplicación usa Python 3.5 o posterior, se pueden agregar anotaciones de tipo, como se describe en PEP 484, al código. Las anotaciones de tipo indican los tipos de datos de las variables, los parámetros y los valores de retorno de las funciones, así como la estructura de los documentos. Algunos IDE pueden usar sugerencias de tipo para verificar el código en busca de errores de tipo y sugerir opciones adecuadas para la finalización del código.

Para usar sugerencias de tipo en su aplicación PyMongo, debe agregar una anotación de tipo a su objeto MongoClient, como se muestra en el siguiente ejemplo. Seleccione el Synchronous o pestaña Asynchronous para ver el código correspondiente:

from pymongo import MongoClient
client: MongoClient = MongoClient()

from pymongo import AsyncMongoClient
client: AsyncMongoClient = AsyncMongoClient()

Para obtener información más precisa sobre el tipo, se puede incluir el tipo de documento genérico Dict[str, Any] en la anotación de tipo. Este tipo de datos coincide con todos los documentos en MongoDB. El siguiente ejemplo muestra cómo incluir este tipo de datos en la anotación de tipo. Se debe seleccionar la pestaña Synchronous o Asynchronous para ver el código correspondiente:

from pymongo import MongoClient
from typing import Any, Dict
client: MongoClient[Dict[str, Any]] = MongoClient()

from pymongo import AsyncMongoClient
from typing import Any, Dict
client: AsyncMongoClient[Dict[str, Any]] = AsyncMongoClient()

Si todos los documentos con los que se trabaja corresponden a un único tipo personalizado, se puede especificar el tipo personalizado como una sugerencia de tipo para el objeto MongoClient. Esto proporciona información de tipo más precisa que el tipo genérico Dict[str, Any].

El siguiente ejemplo muestra cómo especificar el tipo Movie como una sugerencia de tipo para un objeto MongoClient. Seleccione la pestaña Synchronous o Asynchronous para ver el código correspondiente:

from typing import TypedDict
class Movie(TypedDict):
    name: str
    year: int
client: MongoClient[Movie] = MongoClient()

from typing import TypedDict
class Movie(TypedDict):
    name: str
    year: int
client: AsyncMongoClient[Movie] = AsyncMongoClient()

Cerrar un MongoClient

Durante la recolección de basura, PyMongo limpia automáticamente los recursos del lado de la aplicación utilizados por una instancia MongoClient. Sin embargo, PyMongo no garantiza el cierre de los recursos del lado del servidor, como las sesiones o cursores abiertos. Se puede garantizar que PyMongo cierre estos recursos mediante el método close() en la instancia MongoClient cuando finalice el uso, como se muestra en el siguiente ejemplo:

client.close()

También puedes instanciar al cliente en una instrucción with, como se muestra en el siguiente ejemplo. El cliente se cierra automáticamente cuando el bloque termina.

with MongoClient("mongodb://localhost:27017/") as client:
   db = client.get_database("mydatabase")
    # Perform further client operations here

Solución de problemas

from pymongo import MongoClient
client = MongoClient()  # error: Need type annotation for "client"

error: Dict entry 0 has incompatible type "str": "int";
expected "Mapping[str, Any]": "int"

client: MongoClient[Dict[str, Any]]

Documentación de la API

Para aprender más sobre cómo crear un objeto MongoClient en PyMongo, consulta la siguiente documentación de API:

• MongoClient

• AsyncMongoClient