Overview
このガイドでは、 Javaドライバーがレプリカセットに対して読み取りおよび書込み (write) 操作を実行する方法を変更するために、書込み保証 (write concern)、読み取り保証 (read concern)、および読み込み設定 (read preference)オプションを構成する方法を学習します。
読み取り設定と書込み設定の優先順位
次のレベルで、書込み保証、読み取り保証、読み込み設定(read preference)のオプションを設定できます。
クライアント(オーバーライドされない限り、すべての操作実行にデフォルトを設定します)
トランザクション
Database
コレクション
このリストは、オプション設定の優先順位の増加順も示しています。例、トランザクションに読み取り保証 (read concern)を設定すると、クライアントから継承された読み取り保証 (read concern)設定が上書きされます。
書込み保証 (write concern) 、読み取り保証 (read concern)) 、読み込み設定 (read preference)オプションを使用すると、レプリカセット内のデータの因果整合性と可用性をカスタマイズできます。 これらのオプションの完全なリストについては、 MongoDB Serverマニュアルの次のガイドを参照してください。
読み取り操作と書込み操作の設定
読み込み設定(読み込み設定 (read preference)を設定することで、ドライバーがレプリカセットメンバー間で読み取り操作をルーティングする方法を制御できます。 また、読み取りおよび書込み保証を設定して、ドライバーがレプリカセットに対する読み取りおよび書込み操作の確認を待機する方法も制御できます。
次のセクションでは、さまざまなレベルでこれらの読み取りと書込み設定を構成する方法を示します。
クライアント構成
この例では、 MongoClientSettingsインスタンスを コンストラクターに渡すことで、MongoClientインスタンスの読み込み設定(読み込み設定 (read preference)、読み取り保証 (read concern)、書込み保証 (write concern)を設定する方法を示しています。 このコードは、次の設定を構成します。
secondary読み込み設定 (read preference): 読み取り操作は、 セカンダリレプリカセットメンバーからデータを取得します。LOCAL読み取り保証 (read concern) : 読み取り操作は、インスタンスの最新データを返しますが、そのデータがレプリカセットのノードの過半数に書き込まれたことを保証します。W2書込み保証 (write concern)) : プライマリレプリカセットノードと 1 つのセカンダリ ノードは、書込み (write)操作を確認する必要があります。
MongoClient mongoClient = MongoClients.create(MongoClientSettings.builder() .applyConnectionString(new ConnectionString("mongodb://localhost:27017/")) .readPreference(ReadPreference.secondary()) .readConcern(ReadConcern.LOCAL) .writeConcern(WriteConcern.W2) .build());
あるいは、接続 URI で読み取り設定と書込み設定を指定することもできます。これはMongoClientsコンストラクターにパラメーターとして渡されます。
MongoClient uriClient = MongoClients.create("mongodb://localhost:27017/?readPreference=secondary&w=2&readConcernLevel=local");
トランザクション構成
この例では、TransactionOptionsインスタンスを startTransaction() メソッドに渡すことで、トランザクションの読み込み設定 (read preference)、読み取り保証 (read concern)) 、書込み保証 (write concern) を設定する方法を示しています。トランザクションは セッション 内で実行されます。これは、順番に実行されるよう関連付けられた読み取り操作または書込み (write) 操作のグループです。トランザクション オプションを適用する前に、セッションを開始するための ClientSessionインスタンスを作成します。
Tip
セッションの詳細については、 MongoDB Serverマニュアルの「 サーバー セッション 」を参照してください。
この例では、次の設定を構成しています。
primary読み込み設定 (read preference): 読み取り操作は、 プライマリレプリカセットメンバーからデータを取得します。MAJORITY読み取り保証 (read concern) : 読み取り操作は、レプリカセットノードの過半数に書き込まれたインスタンスの最新データを返します。W1書込み保証 (write concern)) : プライマリレプリカセットノードは書込み (write)操作を確認する必要があります。
TransactionOptions tOptions = TransactionOptions.builder() .readPreference(ReadPreference.primary()) .readConcern(ReadConcern.MAJORITY) .writeConcern(WriteConcern.W1) .build(); try (ClientSession clientSession = client.startSession()) { clientSession.startTransaction(tOptions); // Specify transaction operations here }
データベース構成
この例では、セッター メソッドを getDatabase() メソッドに連鎖させることで、test_database というデータベースの読み込み設定(読み込み設定 (read preference)、読み取り保証 (read concern)、書込み保証 (write concern)を設定する方法を示しています。 このコードは、次の設定を構成します。
primaryPreferred読み込み設定 (read preference): 読み取り操作は、プライマリレプリカセットメンバーからデータを取得します。プライマリが使用できない場合は セカンダリ メンバーからデータが取得されます。AVAILABLE読み取り保証 (read concern) : 読み取り操作は、インスタンスの最新データを返しますが、そのデータがレプリカセットのノードの過半数に書き込まれたことを保証します。MAJORITY書込み保証 (write concern) ) : すべてのレプリカセットのノードの過半数が書込み (write)操作を確認する必要があります。
MongoDatabase database = mongoClient.getDatabase("test_database") .withReadPreference(ReadPreference.primaryPreferred()) .withReadConcern(ReadConcern.AVAILABLE) .withWriteConcern(WriteConcern.MAJORITY);
コレクション構成
この例では、セッター メソッドを getCollection() メソッドに連鎖させることで、test_collection というコレクションの読み込み設定(読み込み設定 (read preference)、読み取り保証 (read concern)、書込み保証 (write concern)を設定する方法を示しています。 このコードは、次の設定を構成します。
secondaryPreferred読み込み設定 (read preference): 読み取り操作は、セカンダリレプリカセットメンバーからデータを取得します。セカンダリ メンバーが使用できない場合は、プライマリ メンバーからデータが取得されます。AVAILABLE読み取り保証 (read concern) : 読み取り操作は、インスタンスの最新データを返しますが、そのデータがレプリカセットのノードの過半数に書き込まれたことを保証します。UNACKNOWLEDGED書込み保証 (write concern)) : レプリカセット ノードは書込み (write)操作を確認する必要はありません。
MongoCollection<Document> collection = database.getCollection("test_collection") .withReadPreference(ReadPreference.secondaryPreferred()) .withReadConcern(ReadConcern.AVAILABLE) .withWriteConcern(WriteConcern.UNACKNOWLEDGED);
高度な読み取り構成
次のセクションでは、 Javaドライバーが読み取り操作をルーティングする方法をさらにカスタマイズする方法について説明します。
シャーディングされたクラスター
シャーディングされたクラスターに接続する 際に、読み込み設定 (read preference)を指定できます。MongoDB はシャーディングを使用して、データセットをキー範囲ごとに分割し、複数のデータベースインスタンスにデータを分散します。シャーディングされたクラスター、またはシャーディングされた配置内のノードのセットには、次のコンポーネントが含まれます。
シャード : シャーディングされたデータのサブセットを含むレプリカセット。
Mongos :アプリケーションとシャーディングされたクラスター間のインターフェースを提供するクエリ ルーター。
コンフィギュレーションサーバー : クラスターの構成設定とメタデータを保存するサーバー。
Tip
シャーディングされたクラスターの詳細については、 MongoDB Serverマニュアルのシャーディングを参照してください。
レプリカセットシャードから読み取る場合、 mongos は指定された読み込み設定 (read preference)を適用します。読み込み設定 (read preference)は、操作ごとに再評価されます。
次の例は、シャーディングされたクラスターに接続し、接続文字列で secondary読み込み設定 (read preference)を指定する方法を示しています。
MongoClient uriClient = MongoClients.create("mongodb://user:password@mongos1.example.com,mongos2.example.com/?readPreference=secondary");
タグセット
MongoDB Serverでは、選択した任意の基準に従ってレプリカセットメンバーにキーと値のタグを適用できます。次に、それらのタグを使用して、1 つ以上のノードを 読み取り操作の対象にすることができます。
デフォルトでは 、 Javaドライバーは、読み取りノードを選択するときに タグを無視します。Javaドライバーに特定のタグを優先するように指定するには、タグをリストとして読み込み設定 (read preference)セッター メソッドに渡します。
米国の複数のデータセンターでホストされているノードを含むレプリカセットに接続しているとします。 ドライバーが次の順序でセカンダリレプリカセットメンバーからの読み取りを優先するようにします。
タグ付けされた ニューヨークデータセンターのメンバー
("dc", "ny")サンフランシスコデータセンターのメンバー( でタグ付け)
("dc", "sf")セカンダリ ノード
このコード例では、前述のレプリカセットメンバーを表すタグのリストを ReadPreference.secondary() セッター メソッドに渡します。 次に、コードは読み込み設定 (read preference)情報を withReadPreference() メソッドに渡して、データベースに読み取り順序を設定します。
TagSet tag1 = new TagSet(new Tag("dc", "ny")); TagSet tag2 = new TagSet(new Tag("dc", "sf")); TagSet tag3 = new TagSet(); ReadPreference readPref= ReadPreference.secondary(Arrays.asList(tag1, tag2, tag3)); MongoDatabase database = mongoClient.getDatabase("test_database") .withReadPreference(readPref);
ロード バランシング
シャーディングされたクラスターまたはレプリカセットに接続すると、 Javaドライバーは負荷分散を使用して読み取りおよび書込みリクエストを処理します。負荷分散により、ドライバーはこれらのリクエストを複数のサーバーに分散できるため、1 つのサーバーが過負荷になるのを回避し、最適なパフォーマンスを確保します。
シャーディングされたクラスターに接続する場合、 Javaドライバーは、ネットワーク ラウンド トリップ時間が最も短い mongos インスタンスを計算し、最も近い mongosインスタンスを決定します。次に、ドライバーはこの mongos の平均ラウンドトリップ時間を localThresholdMS 値 に追加してレイテンシウィンドウを決定します。ドライバーは、レイテンシウィンドウ内の最大 2 つのランダムな mongos インスタンスにわたってリクエストを分散します。ドライバーは、リクエストごとに、operationCount 値を決定し、操作負荷の低いサーバーを選択します。
レプリカセットに接続すると、 Javaドライバーはまず、読み込み設定 (read preference)に従ってレプリカセットメンバーを選択します。その後、ドライバーは前のセクションで説明したのと同じプロセスに従います。レイテンシウィンドウを計算した後、ドライバーはウィンドウ内にあるランダムなレプリカセットメンバーを最大 2 つ選択し、operationCount 値が低いメンバーを選択してリクエストを受信します。
Tip
負荷分散の詳細については、 MongoDB Serverマニュアルのシャードクラスタのバランサーを参照してください。
ドライバーのサーバー選択動作をカスタマイズする方法については、「 MongoClient 設定の指定 」ガイドの クラスター設定を参照してください。
LocalThreshold
Javaドライバーは、ローカルしきい値を使用して、サーバー選択のレイテンシウィンドウを計算します。この値により、読み取りリクエストと書込みリクエストを受信する資格のあるサーバーが決まります。
デフォルトでは 、ドライバーは mongos インスタンスまたはレプリカセットpingのうち 最も近いサーバーの15ミリ秒以内のみを使用します。より高いレイテンシを持つサーバーに読み取りを分散するには、MongoClientSettingsインスタンスで localThreshold オプションを設定するか、接続 URI で localThresholdMS オプションを設定します。
注意
単一の mongosインスタンスからレプリカセットノードを選択する場合、 Javaドライバーは localThresholdMS オプションを無視します。この場合は、localThreshold コマンドライン オプション を使用します。
次の例ではレプリカセットに接続し、35 ミリ秒のローカルしきい値を指定しています。各アプローチに対応するコードを表示するには、MongoClientSettings または Connection URIタブを選択します。
MongoClient client = MongoClients.create(MongoClientSettings.builder() .applyConnectionString(new ConnectionString("mongodb://localhost:27017/")) .applyToClusterSettings(builder -> builder.localThreshold(35, TimeUnit.MILLISECONDS)) .build());
String connectionString = "mongodb://localhost:27017/?replicaSet=repl0&localThresholdMS=35"; MongoClient client = MongoClients.create(connectionString);
前の例では、 Javaドライバーは、ノードのping時間の 35 ミリ秒以内に、一致するノードに読み取りを分散します。
API ドキュメント
このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。