Bancos de dados e coleções

Coleção de séries temporais

As coleções de séries temporais armazenam eficientemente sequências de medições durante um período de tempo. O exemplo a seguir cria uma coleção de séries temporais chamada example_ts_collection na qual o campo de tempo dos documentos é chamado timestamp. Selecione a aba Synchronous ou Asynchronous para ver o código correspondente:

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 obter mais informações sobre o uso de dados de série temporal com o PyMongo, consulte o guia Dados de série temporal .

Coleção limitada

Você pode criar uma collection limitada que não pode ultrapassar um tamanho de memória ou contagem de documento especificado. O exemplo a seguir cria uma collection limitada chamada example_capped_collection que tem um tamanho máximo de 1000 bytes. Selecione a aba Synchronous ou Asynchronous para ver o código correspondente:

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 saber mais sobre coleções limitadas, consulte Coleções limitadas no manual do MongoDB Server .

Database

Se todos os documentos em um banco de dados corresponderem a um esquema bem definido, você poderá especificar uma dica de tipo que usa uma classe Python para representar a estrutura dos documentos. Ao incluir essa classe na dica de tipo do seu objeto Database, você pode garantir que todos os documentos armazenados ou recuperados tenham a estrutura necessária. Isso fornece uma verificação de tipo e conclusão de código mais precisas do que o tipo Dict[str, Any] padrão.

Primeiro, defina uma classe para representar um documento do banco de dados. A classe deve herdar da classe TypedDict e deve conter os mesmos campos que os documentos no banco de dados. Depois de definir sua classe, inclua seu nome como tipo genérico para a dica de tipo Database.

O exemplo a seguir define uma classe Movie e a utiliza como tipo genérico para uma dica de tipo Database. Selecione a aba Synchronous ou Asynchronous para ver o código correspondente:

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"]

collection

Adicionar um tipo genérico a uma dica de tipo do Collection é semelhante a adicionar um tipo genérico a uma dica de tipo do Database. Primeiro, defina uma classe que herda da classe TypedDict e representa a estrutura dos documentos na collection. Em seguida, inclua o nome da classe como o tipo genérico para a dica de tipo Collection, conforme mostrado no exemplo a seguir. Selecione a aba Synchronous ou Asynchronous para ver o código correspondente:

from typing import TypedDict
from pymongo import MongoClient
from pymongo.asynchronous.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.collection import Collection
class Movie(TypedDict):
    name: str
    year: int
client: AsyncMongoClient = AsyncMongoClient()
database = client["test_database"]
collection: Collection[Movie] = database["test_collection"]

Anotações do tipo de cliente

Se você não adicionar uma anotação de tipo para seu objeto MongoClient, seu verificador de tipo poderá mostrar um erro semelhante ao seguinte:

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

A solução é anotar o objeto MongoClient como client: MongoClient ou client: MongoClient[Dict[str, Any]].

Tipo incompatível

Se você especificar MongoClient como uma dica de tipo, mas não incluir tipos de dados para o documento, as chaves e os valores, seu verificador de tipo poderá mostrar um erro semelhante ao seguinte:

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

A solução é adicionar a seguinte dica de tipo ao seu objeto MongoClient :

``client: MongoClient[Dict[str, Any]]``

AutoReconnect Erro

Você recebe este erro se especificar tag-sets em sua preferência de leitura e o MongoDB não conseguir encontrar membros do conjunto de réplicas com as tags especificadas. Para evitar esse erro, inclua um dicionário vazio ({}) no final da lista de conjuntos de tags. Isso instrui o PyMongo a ler de qualquer membro que corresponda ao modo de referência de leitura quando não conseguir encontrar tags correspondentes.