Stable API

Overview

このガイドでは、MongoDB 配置に接続するときにStable API互換性を指定する方法を学習できます。

Stable API 機能を使用すると、指定された API バージョンと互換性のある動作でサーバーに操作が強制的に実行されます。 ドライバーまたはサーバーのいずれかを更新すると、API バージョンが変更され、これらの操作の動作が変わる可能性があります。 Stable API を使用すると、サーバーからの一貫した応答が確保され、アプリケーションの API の長期的な安定性が確保されます。

次のセクションでは、MongoDB クライアントの Stable API を有効にしてカスタマイズする方法について説明します。 Stable APIサポートするコマンドのリストを含むStable API の詳細については、MongoDB Server マニュアルの「 」を参照してください。

Stable API を有効にする

Stable API を有効にするには、次の手順を実行します。

1. ServerApiオブジェクトを構築し、Stable API バージョンを指定します。 ServerApiVersion列挙型で定義された Stable API バージョンを使用する必要があります。

2. server_api引数にServerApiオブジェクトを渡して、 MongoClientオブジェクトを構築します。

次のコード例は、Stable APIバージョン 1 を指定する方法を示しています。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

from pymongo import MongoClient
from pymongo.server_api import ServerApi
client = MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                     server_api=ServerApi("1"))

from pymongo import AsyncMongoClient
from pymongo.server_api import ServerApi
client = AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                          server_api=ServerApi("1"))

指定された API バージョンでMongoClientインスタンスを作成すると、クライアントで実行されるすべてのコマンドが指定されたバージョンを使用します。 Stable API の複数のバージョンを使用してコマンドを実行する必要がある場合は、新しいMongoClientを作成します。

Stable API の構成

次の表では、 ServerApiクラスのパラメータを説明しています。 これらのパラメーターを使用して、Stable API の動作をカスタマイズできます。

次のコード例は、ServerApiオブジェクトを構築するときにこれらのパラメータを使用する方法を示しています。対応するコードを表示するには、Synchronous タブまたは Asynchronousタブを選択します。

from pymongo import MongoClient
from pymongo.server_api import ServerApi
client = MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                     server_api=ServerApi("1",
                     strict=True,
                     deprecation_errors=True))

from pymongo import AsyncMongoClient
from pymongo.server_api import ServerApi
client = AsyncMongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>",
                          server_api=ServerApi("1",
                          strict=True,
                          deprecation_errors=True))

トラブルシューティング

API ドキュメント

PyMongo で Stable API を使用する方法の詳細については、次の API ドキュメントを参照してください。

• MongoClient

• ServerApi

• ServerApiVersion