Bases de datos y colecciones

Colección de series de tiempo

Las colecciones de series de tiempo almacenan eficientemente secuencias de mediciones a lo largo de un período de tiempo. El siguiente ejemplo crea una colección de series de tiempo llamada example_ts_collection en la que el campo de tiempo de los documentos se denomina timestamp. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

database = client["test_database"]
database.create_collection("example_ts_collection", timeseries={"timeField": "timestamp"})

database = client["test_database"]
await database.create_collection("example_ts_collection", timeseries={"timeField": "timestamp"})

Para obtener más información sobre el uso de datos de series de tiempo con PyMongo, consulte la Guíade datos de series de tiempo.

Colección con tamaño fijo

Puedes crear una colección con tamaño fijo que no pueda crecer más allá de un tamaño de memoria o un número de documentos especificados. El siguiente ejemplo crea una colección con tamaño fijo llamada example_capped_collection que tiene un tamaño máximo de 1000 bytes. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

database = client["test_database"]
database.create_collection("example_capped_collection", capped=True, size=1000)

database = client["test_database"]
await database.create_collection("example_capped_collection", capped=True, size=1000)

Para obtener más información sobre las colecciones con tamaño fijo, consulta Colecciones con tamaño fijo en el manual de MongoDB Server.

Database

Si todos los documentos en una base de datos coinciden con un esquema bien definido, se puede especificar una sugerencia de tipo que use una clase de Python para representar la estructura de los documentos. Al incluir esta clase en la sugerencia de tipo para el objeto Database, se puede garantizar que todos los documentos que se almacenen o recuperen tengan la estructura requerida. Esto proporciona una comprobación de tipos y una finalización de código más precisas que el tipo Dict[str, Any] por defecto.

Primero, se debe definir una clase para representar un documento de la base de datos. La clase debe heredar de la clase TypedDict y debe contener los mismos campos que los documentos en la base de datos. Después de definir la clase, se debe incluir el nombre como el tipo genérico para la sugerencia de tipo Database.

El siguiente ejemplo define una clase Movie y la utiliza como tipo genérico para una pista de tipo Database. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

from typing import TypedDict
from pymongo import MongoClient
from pymongo.database import Database
class Movie(TypedDict):
    name: str
    year: int
client: MongoClient = MongoClient()
database: Database[Movie] = client["test_database"]

from typing import TypedDict
from pymongo import AsyncMongoClient
from pymongo.asynchronous.database import Database
class Movie(TypedDict):
    name: str
    year: int
client: AsyncMongoClient = AsyncMongoClient()
database: Database[Movie] = client["test_database"]

Colección

Agregar un tipo genérico a una indicación de tipo Collection es similar a agregar un tipo genérico a una indicación de tipo Database. Primero, define una clase que herede de la clase TypedDict y represente la estructura de los documentos en la colección. Luego, incluye el nombre de la clase como tipo genérico para la sugerencia de tipo Collection, como se muestra en el siguiente ejemplo. Selecciona la pestaña Synchronous o Asynchronous para ver el código correspondiente:

from typing import TypedDict
from pymongo import MongoClient
from pymongo.collection import Collection
class Movie(TypedDict):
    name: str
    year: int
client: MongoClient = MongoClient()
database = client["test_database"]
collection: Collection[Movie] = database["test_collection"]

from typing import TypedDict
from pymongo import AsyncMongoClient
from pymongo.asynchronous.collection import Collection
class Movie(TypedDict):
    name: str
    year: int
client: AsyncMongoClient = AsyncMongoClient()
database = client["test_database"]
collection: Collection[Movie] = database["test_collection"]

Anotaciones de tipo de cliente

Si no se agrega una anotación de tipo para el objeto MongoClient, el verificador de tipos podría mostrar un error similar al siguiente:

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

La solución es anotar el objeto MongoClient como client: MongoClient o client: MongoClient[Dict[str, Any]].

Tipo incompatible

Si especifica MongoClient como una sugerencia de tipo, pero no incluye los tipos de datos para el documento, las claves y los valores, su verificador de tipos podría mostrar un error similar al siguiente:

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

La solución es agregar la siguiente sugerencia de tipo al objeto MongoClient:

client: MongoClient[Dict[str, Any]]

AutoReconnect Error

Se recibe este error si se especifica tag-sets en la preferencia de lectura y MongoDB no puede encontrar nodos del set de réplicas con las etiquetas especificadas. Para evitar este error, se debe incluir un diccionario vacío ({}) al final de la lista de conjuntos de etiquetas. Esto indica a PyMongo que debe leer de cualquier nodo que coincida con el modo de referencia de lectura cuando no pueda encontrar etiquetas coincidentes.