クライアントレベルのCRUD設定を構成する

Overview

このガイドでは、 Javaドライバーを使用して MongoClient インスタンスのCRUD操作を構成する方法について説明します。

読み込み設定（read preference ）、読み取り保証（ read concern ）、書込み保証（ write concern ）は、MongoDB レプリカセットに接続するときに、ドライバーが読み取り操作をルーティングして読み取りおよび書込み操作の確認を待つ方法を制御します。読み込み設定（read preference）と読み取り保証（read concern）はすべての読み取り操作に適用されます。書込み保証 (write concern) はすべての書込み (write) 操作に適用されます。

詳細については、読み込み設定（ read preference ）、読み取り保証（ read concern ）、書込み保証（ write concern）に関するサーバーのドキュメントを参照してください。

MongoDatabase MongoCollection インスタンスは、それらにアクセスする MongoClient から設定と懸念事項を継承します。ただし、データベースとコレクションにカスタム設定を適用することができます。詳細については、カスタム CRUD 設定の構成ページを参照してください。

接続文字列を使用するか、MongoClients コンストラクターに MongoClientSettingsオブジェクトを渡すことで、クライアントレベルのCRUD設定を指定できます。使用可能なオプションを確認するには、Connection String タブまたは MongoClientSettingsタブを選択します。

ドライバーの読み取りまたは書込み動作を変更するには、接続文字列に次のパラメーターを含めます。

オプション名	タイプ	説明
`journal`	ブール値	接続された MongoDB インスタンスがすべての書き込みに対してディスク上のジャーナルファイルにグループコミットするまで、ドライバーが待機する必要があることを指定します。デフォルト: `false`
`w`	string or integer	書込み保証 (write concern)を指定します。値の詳細については、w オプションのMongoDB Server のドキュメントを参照してください。デフォルト: `1`
`wtimeoutMS`	integer	書込み保証 (write concern)の時間制限をミリ秒単位で指定します。詳細については、 MongoDB Server のドキュメントの wtimeoutMS オプションを参照してください。値が `0` の場合は、書込み操作がタイムアウトしないようにドライバーに指示します。デフォルト: `0`
`readPreference`	string	読み込み設定 (read preference)を指定します。値の詳細については、readPreference オプションのMongoDB Server のドキュメントを参照してください。デフォルト: `primary`
`readPreferenceTags`	string	読み込み設定 (read preference)タグを指定します。値の詳細については、readPreferenceTags オプションのMongoDB Server のドキュメントを参照してください。デフォルト: `null`
`maxStalenessSeconds`	integer	ドライバーがセカンダリとの通信を停止する前に、セカンダリがどの程度古くなった時点でセカンダリとの通信を停止するかを秒単位で指定します。の最小値は、90 秒またはハートビート頻度に 10 秒を加えた値のうち大きい方です。詳細については、 MongoDB Server のドキュメントの maxStalenessSeconds オプションを参照してください。パラメータを指定しない場合、または `-1` を明示的に指定している場合は、セカンダリの古さチェックを行わない必要があることを示します。デフォルト: `-1`
`uuidRepresentation`	string	読み取り操作と書込み (write) 操作に使用する UUID 表現を指定します。詳しくは、MongoClientSettings.getUuidRepresentation() メソッドのドライバードキュメントを参照してください。デフォルト: `unspecified`
`retryWrites`	ブール値	ネットワークエラーにより完了できない場合、サポートされている書き込み操作を再試行する必要があることを指定します。デフォルト: `true`
`retryReads`	ブール値	ネットワークエラーにより完了できない場合、サポートされている読み取り操作を再試行する必要があることを指定します。デフォルト: `true`
`maxAdaptiveRetries`	integer	再試行可能な過負荷エラー（`SystemOverloadedError`と`RetryableError`の両方のラベルが付いたエラー）で失敗したコマンドをドライバーが再試行する最大回数を設定します。このオプションは、`retryWrites` が `true` に設定されている場合の書き込み (write)コマンドと、`retryReads` が `true` に設定されている場合の読み取りコマンドにのみ適用されます。値を `0` に設定すると、再試行可能な過負荷エラーに対する再試行試行が無効になります。デフォルト: `null`。このオプションが設定されていない場合、ドライバーは通常、値 `2` を適用します。
`enableOverloadRetargeting`	ブール値	後続の再試行試行のサーバー選択中に、以前に過負荷エラーを返したサーバーの優先順位を下げるかどうかをドライバーに設定します。このオプションは、`retryReads` が `true` に設定されている場合の読み取りと、`retryWrites` が `true` に設定されている場合の書き込み (write) に適用するされます。このオプションは、シャーディングされたクラスターには適用するされません。デフォルト: `false`

次の例では、最も近いレプリカセットメンバーから読み取るように読み込み設定 (read preference)を設定します。

ConnectionString connectionString = "mongodb://<host>:<port>/?readPreference=nearest"MongoClient mongoClient = MongoClients.create(connectionString)

これらのパラメーターの詳細については、ConnectionString APIドキュメントを参照してください。

ドライバーの読み取り/書込み動作を変更するには、次のメソッドを MongoClientSettings コンストラクターにチェーンします。

`enableOverloadRetargeting()`	後続の再試行試行のサーバー選択中に、サーバーが以前に過負荷エラーを返した場合に、ドライバーがサーバーの優先順位を下げるかどうかを設定します。`retryReads()` が `true` に設定されている場合の読み取りと、`retryWrites()` が `true` に設定されている場合の書き込み (write)に適用する。シャーディングされたクラスターには適用するされません。デフォルト: `false`
`maxAdaptiveRetries()`	再試行可能な過負荷エラー（つまり、`SystemOverloadedError`と`RetryableError`の両方のラベルを持つエラー）で失敗したコマンドをドライバーが再試行する最大回数を設定します。`retryWrites()`が`true`に設定されている場合は書き込み (write)コマンドにのみ適用され、`retryReads()`が`true`に設定されている場合は読み取りコマンドにのみ適用されます。値を`0`に設定すると、再試行可能な過負荷エラーに対する再試行試行が無効になります。デフォルト: `null`。このオプションが設定されていない場合、ドライバーは通常、値 `2` を適用します。
`readConcern()`	読み取り保証 (read concern)を設定します。サーバーマニュアルページ APIドキュメント
`readPreference()`	読み込み設定 (read preference)を設定するデフォルト: `primary`
`retryReads()`	ネットワークエラーが発生した場合にドライバーが読み取りの再試行を実行するかどうか。デフォルト: `true`
`retryWrites()`	ネットワークエラーが発生した場合にドライバーが書込みを再試行するかどうか。デフォルト: `true`
`uuidRepresentation()`	UUID のインスタンスをエンコードし、サブタイプが 3 の BSON バイナリ値をデコードするときに使用する UUID 表現を設定します。
`writeConcern()`	書込み保証 ( write concern) を設定します。デフォルト : `WriteConcern#ACKNOWLEDGED`。\| デフォルト値の詳細については、暗黙のデフォルト書込み保証 (write concern) を参照してください。

次の例では、最も近いレプリカセットメンバーから読み取るように読み込み設定 (read preference)を設定します。

MongoClient mongoClient = MongoClients.create(        MongoClientSettings.builder().applyConnectionString(new ConnectionString("<your connection string>"))                .readPreference(ReadPreference.nearest())                .build());

これらのメソッドの詳細については、MongoClientSettings.Builder APIドキュメントを参照してください。

注意

Intelligent ワークロードマネジメント (IWM) におけるロードシェディング

SystemOverloadedError または RetryableError ラベルのエラーがアプリケーションで障害を引き起こしている場合、またはアプリケーションのログに表示されている場合、クラスターで Load Shedding がアクティブになっており、ドライバーがそれをサポートするバージョンにアップグレードされていない可能性があります。MongoDB Java ドライバーをバージョン5.8以降にアップグレードすることをお勧めします。アップグレード後もこれらのエラーが続く場合は、Load Shedding 設定の検討などのサーバー側の変更、またはカスタムエラー処理やクライアント側のリクエストスロットリングの実装するなどのアプリケーション側の変更によって対処できます。状況によっては、アプリケーション側の変更が望ましい、または必要な場合があります。

Load Shedding は IWM の機能であり、過負荷が継続している間に過剰な操作を拒否することでサーバーの負荷を管理するのに役立ちます。この機能は MongoDB 9.0 以降で使用できます。

IWM またはオーバーロードエラーの処理について詳しくは、インテリジェントワークロードマネジメントページまたはオーバーロードエラーページを Atlas ドキュメントで参照してください。

戻る

ソケット設定

ネットワーク圧縮