データベースとコレクション

時系列コレクション

時系列コレクションは一定期間にわたる測定値のシーケンスを効率的に保存します。次の例では、ドキュメントの時間フィールドが timestamp と呼ばれる example_ts_collection という時系列コレクションを作成します。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

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"})

PyMongoで時系列データを使用する方法の詳細については、「 時系列データガイド 」を参照してください。

上限付きコレクション

指定されたメモリ サイズまたはドキュメント数を超えて増えることのない、Cappedコレクションを作成できます。次の例では、最大サイズが 1000 バイトの example_capped_collection という名前のCappedコレクションを作成します。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

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)

Capped コレクションの詳細については、 MongoDB Serverマニュアルの「 Capped コレクション 」を参照してください。

Database

データベース内のすべてのドキュメントが明確に定義されたスキーマと一致する場合は、ドキュメントの構造を表すためにPythonクラスを使用する型のヒントを指定できます。このクラスをDatabaseオブジェクトの型のヒントに含めることで、保存または検索するすべてのドキュメントが必要な構造を持つようになります。これにより、デフォルトのDict[str, Any] 型よりも正確な型チェックとコード完了が提供されます。

まず、データベースのドキュメントを表すクラスを定義します。クラスはTypedDictクラスから継承し、データベース内のドキュメントと同じフィールドを含む必要があります 。クラスを定義した後、Database 型ヒントのジェネリック型としてその名前を含めます。

次の例では、Movieクラスを定義し、それを Database 型ヒントのジェネリック型として使用します。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

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 型ヒントにジェネリック型を追加する方法は、Database 型ヒントにジェネリック型を追加するのと同様です。まず、TypedDictクラスから継承し、コレクション内のドキュメントの構造を表すクラスを定義します。次に、次の例に示すように、Collection 型ヒントのジェネリック型としてクラス名を含めます。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

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

クライアント タイプの注釈

MongoClientオブジェクトに型注釈を追加しない場合、型チェッカーに次のようなエラーが表示される場合があります。

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

解決策としては、MongoClientオブジェクトを client: MongoClient または client: MongoClient[Dict[str, Any]] として注釈を付けることです。

互換性のないタイプ

型のヒントとして MongoClient を指定しているが、ドキュメント、キー、値のデータ型を含めない場合、型チェッカーに次のようなエラーが表示される場合があります。

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

解決策としては、次のタイプのヒントを MongoClientオブジェクトに追加することです。

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

AutoReconnect エラー

読み込み設定（read preference）でtag-setsを指定しており、MongoDB が指定されたタグを持つレプリカセット メンバーを見つけられない場合は、このエラーが表示されます。 このエラーを回避するには、タグセット リストの最後に空の辞書（ {} ）を含めます。 これにより、一致するタグが見つからない場合は、読み取り参照モードに一致するノードから読み取るように PyMongo に指示します。