CRUD操作の構成

読み取り設定と書込み設定の優先順位

次のレベルで、書込み保証、読み取り保証、読み込み設定（read preference）のオプションを設定できます。

• クライアント（オーバーライドされない限り、すべての操作実行にデフォルトを設定します）

• トランザクション

• Database

• コレクション

このリストは、オプション設定の優先順位の増加順も示しています。例、トランザクションに読み取り保証 (read concern)を設定すると、クライアントから継承された読み取り保証 (read concern)設定が上書きされます。

書込み保証 (write concern) 、読み取り保証 (read concern)、読み込み設定 (read preference)オプションを使用すると、レプリカセット内のデータの因果整合性と可用性をカスタマイズできます。これらのオプションの完全なリストについては、 MongoDBサーバーマニュアルの次のガイドを参照してください。

• 読み込み設定 (read preference)

• 読み取り保証（read concern）

• 書込み保証 (write concern)

クライアント構成

この例では、MongoClientSettingsインスタンスを MongoClient.create() メソッドに渡すことで、MongoClientインスタンスの読み込み設定 (read preference)、読み取り保証 (read concern)） 、書込み保証 (write concern)を設定する方法を示しています。このコードは、次の設定を構成します。

• secondary 読み込み設定 (read preference): 読み取り操作は、 セカンダリレプリカセットメンバーからデータを取得します。

• LOCAL 読み取り保証 (read concern) : 読み取り操作は、インスタンスの最新データを返しますが、そのデータがレプリカセットのノードの過半数に書き込まれたことを保証します。

• W2 書込み保証 (write concern)) : プライマリレプリカセットノードと 1 つのセカンダリ ノードは、書込み (write)操作を確認する必要があります。

val settings = MongoClientSettings.builder()
    .applyConnectionString(ConnectionString("mongodb://localhost:27017/"))
    .readPreference(ReadPreference.secondary())
    .readConcern(ReadConcern.LOCAL)
    .writeConcern(WriteConcern.W2)
    .build()
val mongoClient = MongoClient.create(settings)

あるいは、接続 URI で読み取り設定と書込み設定を指定することもできます。これは MongoClient.create() メソッドのパラメーターとして渡されます。

val uri = "mongodb://localhost:27017/?readPreference=secondary&w=2&readConcernLevel=local"
val uriClient = MongoClient.create(uri)

トランザクション構成

この例では、 TransactionOptionsインスタンスをstartTransaction() メソッドに渡すことで、トランザクションの 読み込み設定（読み込み設定 (read preference)、読み取り保証 (read concern)、書込み保証 (write concern)を設定する方法を示しています。トランザクションは セッション 内で実行されます。これは、順番に実行されるよう関連付けられた読み取り操作または書込み操作のグループです。

この例では、次の設定を構成しています。

• primary 読み込み設定 (read preference): 読み取り操作は、 プライマリレプリカセットメンバーからデータを取得します。

• MAJORITY 読み取り保証 (read concern) : 読み取り操作は、レプリカセットノードの過半数に書き込まれたインスタンスの最新データを返します。

• W1 書込み保証 (write concern)) : プライマリレプリカセットノードは書込み (write)操作を確認する必要があります。

mongoClient.startSession().use { session ->
    try {
        // Sets transaction read and write settings
        val txnOptions = TransactionOptions.builder()
            .readPreference(ReadPreference.primary())
            .readConcern(ReadConcern.MAJORITY)
            .writeConcern(WriteConcern.W1)
            .build()
        runBlocking {
            session.startTransaction(txnOptions)
            // Specify transaction operations here
            session.commitTransaction()
        }
    } catch (e: Exception) {
        println("Transaction failed: ${e.message}")
    }
}

データベース構成

この例では、セッター メソッドを getDatabase() メソッドに連鎖させることで、test_database というデータベースの読み込み設定（読み込み設定 (read preference)、読み取り保証 (read concern)、書込み保証 (write concern)を設定する方法を示しています。 このコードは、次の設定を構成します。

• primaryPreferred 読み込み設定 (read preference): 読み取り操作は、プライマリレプリカセットメンバーからデータを取得します。プライマリが使用できない場合は セカンダリ メンバーからデータが取得されます。

• AVAILABLE 読み取り保証 (read concern) : 読み取り操作は、インスタンスの最新データを返しますが、そのデータがレプリカセットのノードの過半数に書き込まれたことを保証します。

• MAJORITY 書込み保証 (write concern) ) : すべてのレプリカセットのノードの過半数が書込み (write)操作を確認する必要があります。

val 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)操作を確認する必要はありません。

val collection = database.getCollection<Document>("test_collection")
    .withReadPreference(ReadPreference.secondaryPreferred())
    .withReadConcern(ReadConcern.AVAILABLE)
    .withWriteConcern(WriteConcern.UNACKNOWLEDGED)

シャーディングされたクラスター

シャーディングされたクラスターに接続する 際に、読み込み設定 (read preference)を指定できます。MongoDB はシャーディングを使用して、データセットをキー範囲ごとに分割し、複数のデータベースインスタンスにデータを分散します。シャーディングされたクラスター、またはシャーディングされた配置内のノードのセットには、次のコンポーネントが含まれます。

• シャード : シャーディングされたデータのサブセットを含むレプリカセット。

• Mongos :アプリケーションとシャーディングされたクラスター間のインターフェースを提供するクエリ ルーター。

• コンフィギュレーションサーバー : クラスターの構成設定とメタデータを保存するサーバー。

レプリカセットシャードから読み取る場合、mongos は指定された読み込み設定 (read preference)を適用します。読み込み設定 (read preference)は、操作ごとに再評価されます。

次の例は、シャーディングされたクラスターに接続し、接続文字列で secondary読み込み設定 (read preference)を指定する方法を示しています。

val shardedClient = MongoClient.create(
    "mongodb://user:password@mongos1.example.com,mongos2.example.com/?readPreference=secondary"
)

タグセット

MongoDBサーバーでは、選択した任意の基準に従ってレプリカセットメンバーにキーと値のタグを適用できます。次に、それらのタグを使用して、1 つ以上のノードを 読み取り操作の対象にすることができます。

デフォルトでは 、 Kotlinドライバーは 、読み取り元のノードを選択するときに タグ付けを無視します。Kotlinドライバーに特定のタグを優先するように指示するには、タグをリストとして読み込み設定 (read preference) セッター メソッドに渡します。

米国の複数のデータセンターでホストされているノードを含むレプリカセットに接続しているとします。 ドライバーが次の順序でセカンダリレプリカセットメンバーからの読み取りを優先するようにします。

1. タグ付けされた ニューヨークデータセンターのメンバー ("dc", "ny")

2. サンフランシスコデータセンターのメンバー（ でタグ付け） ("dc", "sf")

3. セカンダリ ノード

このコード例では、前述のレプリカセットメンバーを表すタグのリストを ReadPreference.secondary() セッター メソッドに渡します。 次に、コードは読み込み設定 (read preference)情報を withReadPreference() メソッドに渡して、データベースに読み取り順序を設定します。

val tag1 = TagSet(Tag("dc", "ny"))
val tag2 = TagSet(Tag("dc", "sf"))
val tag3 = TagSet() // Empty tag set as fallback
val readPref = ReadPreference.secondary(listOf(tag1, tag2, tag3))
val taggedDb = mongoClient.getDatabase("test_database")
    .withReadPreference(readPref)

ロード バランシング

シャーディングされたクラスターまたはレプリカセットに接続すると、 Kotlinドライバーは負荷分散を使用して読み取りおよび書込みリクエストを処理します。負荷分散により、ドライバーはこれらのリクエストを複数のサーバーに分散できるため、1 つのサーバーが過負荷になるのを回避し、最適なパフォーマンスを確保します。

When connecting to a sharded cluster, the Kotlin driver determines the closest mongos instance by calculating which one has the lowest network round-trip time. Then, the driver determines the latency window by adding this mongos's average round-trip time to the localThresholdMS value. The driver load balances requests across up to two random mongos instances that fall within the latency window. For each request, the driver chooses the server with the lower operation load by determining its operationCount value.

レプリカセットに接続すると、 Kotlinドライバーはまず読み込み設定 (read preference)に従ってレプリカセットメンバーを選択します。その後、ドライバーは前のセクションで説明したのと同じプロセスに従います。レイテンシウィンドウを計算した後、ドライバーはウィンドウ内にあるランダムなレプリカセットノードを最大 2 つ選択し、operationCount 値が低いノードを選択してリクエストを受信します。

val latencySettings = MongoClientSettings.builder()
    .applyConnectionString(ConnectionString("mongodb://localhost:27017/"))
    .applyToClusterSettings { builder ->
        builder.localThreshold(35, TimeUnit.MILLISECONDS)
    }
    .build()
val latencyClient2 = MongoClient.create(latencySettings)

val latencyClient1 = MongoClient.create(
    "mongodb://localhost:27017/?replicaSet=repl0&localThresholdMS=35"
)