Stable API
項目一覧
注意
Stable API 機能には MongoDB Server 5.0 以降が必要です。
Overview
このガイドでは、MongoDB 配置に接続するときにStable API互換性を指定する方法を学習できます。
Stable API 機能を使用すると、指定された API バージョンと互換性のある動作でサーバーに操作が強制的に実行されます。 ドライバーまたはサーバーのいずれかを更新すると、API バージョンが変更され、これらの操作の動作が変わる可能性があります。 Stable API を使用すると、サーバーからの一貫した応答が確保され、アプリケーションの API の長期的な安定性が確保されます。
次のセクションでは、MongoDB クライアントの Stable API を有効にしてカスタマイズする方法について説明します。 サポートするコマンドのリストを含む、Stable API Stable APIの詳細については、MongoDB Server マニュアルの を参照してください。
Stable API を有効にする
Stable API を有効にするには、次の手順を実行します。
ServerApiオブジェクトを作成し、Stable API バージョンを指定します。ServerApiVersion列挙型で定義された Stable API バージョンを使用する必要があります。server_api引数にServerApiオブジェクトを渡して、MongoClientオブジェクトを構築します。
次のコード例は、Stable API バージョン1を指定する方法を示しています。
from pymongo import MongoClient from pymongo.server_api import ServerApi client = MongoClient("mongodb://<db_username>:<db_password>@<hostname:<port>", server_api=ServerApi("1"))
指定された API バージョンでMongoClientインスタンスを作成すると、クライアントで実行されるすべてのコマンドが指定されたバージョンを使用します。 Stable API の複数のバージョンを使用してコマンドを実行する必要がある場合は、新しいMongoClientを作成します。
Stable API の構成
次の表では、 ServerApiクラスのパラメータを説明しています。 これらのパラメーターを使用して、Stable API の動作をカスタマイズできます。
オプション名 | 説明 |
|---|---|
厳密 | Optional. When True, if you call a command that isn't part of
the declared API version, the driver raises an exception.Default: False |
delete_errors | Optional. When True, if you call a command that is deprecated in the
declared API version, the driver raises an exception.Default: False |
次のコード例は、 ServerApiオブジェクトを構築するときにこれらのパラメータを使用する方法を示しています。
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))
トラブルシューティング
サーバー上の認識されないフィールド 'apiVersion'
API バージョンを指定し、Stable API をサポートしていない MongoDB サーバーに接続すると、PyMongo はこの例外を発生させます。 MongoDB Server v 5.0以降を実行している配置に接続していることを確認してください。
apiStrict:true は提供されていますが、コマンド数は API バージョンではありません
指定した Stable API バージョンに含まれない操作をMongoClientが実行する場合、PyMongo はこの例外を発生させます。 このエラーを回避するには、指定された Stable API バージョンでサポートされている別の操作を使用するか、 ServerApiオブジェクトを構築するときにstrictオプションをFalseに設定します。
API ドキュメント
PyMongo で Stable API を使用する方法の詳細については、次の API ドキュメントを参照してください。