Overview
このガイドでは、 Kotlin ドライバーを使用してトランザクションを実行する方法を学習できます。 トランザクションを使用すると、トランザクションがコミットされるまでデータを変更しない一連の操作を実行できます。 トランザクション内のいずれかの操作でエラーが返された場合、ドライバーはトランザクションをキャンセルし、変更が反映される前にすべてのデータ変更を破棄します。
MongoDB では、トランザクションは論理セッション内で実行されます。セッションは、順番に実行されるよう関連付けられた読み取り操作または書き込み操作のグループです。セッションにより、一連の操作に対する因果整合性が有効になる、または ACID transaction 内で操作を実行できるようになります。MongoDBは、トランザクション操作で予期せぬエラーが発生した場合でも、その操作に関わるデータの一貫性が保たれることを保証します。
Kotlin ドライバーを使用すると、 MongoClientインスタンスからClientSessionとして新しいセッションを作成できます。 毎回新しいクライアントをインスタンス化するのではなく、クライアントを複数のセッションやトランザクションで再利用することを推奨します。
警告
ClientSession は、それを作成した MongoClient(または関連付けられたMongoDatabase または MongoCollection)でのみ使用します。ClientSession と、異なる MongoClient を使用すると、操作エラーが発生します。
因果整合性
MongoDB は特定のクライアントセッションで因果整合性を有効にします。因果整合性モデルは、分散システム内でセッション内の操作が因果順序で実行されることを保証します。クライアントは、因果関係、または操作間の依存関係と整合性のある結果を観察します。例、ある操作が別の操作の結果に論理的に依存する一連の操作を実行すると、後続のすべての読み取りは 依存関係を反映します。
因果整合性を保証するには、クライアントセッションが次の要件を満たす必要があります。
セッションを開始するとき、ドライバーは 因果整合性 オプションを有効にする必要があります。このオプションはデフォルトで有効になっています。
操作は 1 つのスレッド上の 1 つのセッションで実行する必要があります。それ以外の場合、セッションまたはスレッドはoperation timeとクラスター時間の値を相互に通信する必要があります。これらの値を通信する 2 つのセッションの例については、 MongoDBサーバーマニュアルの 因果整合性の例 を参照してください。
ReadConcern.MAJORITYの読み取り保証 (read concern)を使用する必要があります。WriteConcern.MAJORITYの書込み保証 (write concern)を使用する必要があります。これは、デフォルトの書込み保証 (write concern)の値です。
次の表では、因果整合性のあるセッションが提供する保証について説明しています。
保証 | 説明 |
|---|---|
書込み操作の結果を読み取る | 読み取り操作は、前の書込み操作の結果を反映します。 |
単調な読み取り | 読み取り操作では、前の 読み取り操作よりも前のデータ状態を反映した結果は返されません。 |
単調書込み | 書込み操作が他の書込み操作に優先する必要がある場合、サーバーはこの書込み操作を最初に実行します。 例、 |
書込み操作の前に読み取り操作をする | 書込み操作が他の読み取り操作の後に続く必要がある場合、サーバーは最初に読み取り操作を実行します。 例、 |
Tip
このセクションで述べられた概念の詳細については、次のMongoDBサーバーのマニュアル エントリを参照してください。
メソッド
ClientインスタンスでstartSession()メソッドを使用してClientSessionを作成します。 その後、次の方法を使用してセッション状態を変更できます。
方式 | 説明 |
|---|---|
| Starts a new transaction for this session with the
default transaction options. You cannot start a
transaction if there's already an active transaction
on the session. To set transaction options, use startTransaction(transactionOptions: TransactionOptions). |
| Ends the active transaction for this session. Returns an error
if there is no active transaction for the
session or the transaction was previously ended. |
| Commits the active transaction for this session. Returns an
error if there is no active transaction for the session or if the
transaction was ended. |
Tip
トランザクション タイムアウト
トランザクション内で操作が完了するまでにかかる時間の制限を設定できます。詳しくは、「 サーバー実行時間制限 」ガイドの「 トランザクション 」セクションを参照してください。
ClientSession には、セッション プロパティを取得し、可変セッション プロパティを変更するメソッドもあります。これらのメソッドの詳細については、 APIドキュメントを表示します。
例
この例では、次の Kotlin データ クラスを使用してドキュメントをモデル化します。
data class Account( val accountId: String, val amount: Int )
次の例は、セッションを作成し、トランザクションを作成し、既存のドキュメントに変更をコミットする方法を示しています。
startSession()メソッドを使用してクライアントからセッションを作成します。トランザクションを開始するには、
startTransaction()メソッドを使用します。指定されたドキュメントを更新し、すべての操作が成功した場合は
commitTransaction()メソッドを使用するか、いずれかの操作が失敗した場合はabortTransaction()を使用します。
// Set up the session val session = client.startSession() try { session.startTransaction() val savingsColl = database .getCollection<Account>("savings_accounts") val checkingColl = database .getCollection<Account>("checking_accounts") savingsColl.findOneAndUpdate( session, eq(Account::accountId.name, "9876"), inc(Account::amount.name, -100), ) checkingColl.findOneAndUpdate( session, eq(Account::accountId.name, "9876"), inc(Account::amount.name, 100) ) // Commit the transaction val result = session.commitTransaction() println("Transaction committed.") } catch (error: Exception) { println("An error occurred during the transaction: ${error.message}") // Abort the transaction session.abortTransaction() }
注意
並列操作はサポートされていません
Kotlinドライバーは、単一のトランザクション内での並列操作の実行中をサポートしていません。
MongoDBサーバーv8.0 以降を使用している場合は、一括書き込み操作を使用して、1 つのトランザクション内で複数の名前空間に対して書き込み操作を実行できます。詳細については、一括操作ガイドを参照してください。
詳細情報
このガイドで言及されている概念の詳細については、サーバー マニュアルの次のページを参照してください。
ACID compliance の詳細については、 「 データベース管理システムの ACID プロパティとは 」を参照してください。 MongoDB Webサイトの記事。
API ドキュメント
このガイドで説明した型やメソッドの詳細については、次の API ドキュメントを参照してください。