トランザクション

因果整合性

MongoDB は特定のクライアントセッションで因果整合性を有効にします。因果整合性モデルは、分散システム内でセッション内の操作が因果順序で実行されることを保証します。クライアントは、因果関係、または操作間の依存関係と整合性のある結果を観察します。例、ある操作が別の操作の結果に論理的に依存する一連の操作を実行すると、後続のすべての読み取りは 依存関係を反映します。

因果整合性を保証するには、クライアントセッションが次の要件を満たす必要があります。

• セッションを開始するとき、ドライバーは 因果整合性 オプションを有効にする必要があります。このオプションはデフォルトで有効になっています。

• 操作は 1 つのスレッド上の 1 つのセッションで実行する必要があります。それ以外の場合、セッションまたはスレッドは optime とクラスター時間の値を相互に通信する必要があります。 これらの値を通信する 2 つのセッションの例については、 MongoDB Serverマニュアルの 因果整合性の例 を参照してください。

• majority の読み取り保証 (read concern)を使用する必要があります。

• majority の書込み保証 (write concern)を使用する必要があります。これは、デフォルトの書込み保証 (write concern)の値です。

次の表では、因果整合性のあるセッションが提供する保証について説明しています。

Core API

Core API では、トランザクションを実装するための次のメソッドが提供されます。

• startSession() : 新しい インスタンスを作成しますClientSession

• startTransaction(): 新しいトランザクションを開始します

• commitTransaction(): トランザクションが作成されたセッション内で、アクティブなトランザクションをコミットします

• abortTransaction() : トランザクションが作成されたセッション内で、アクティブなトランザクションを終了します

• endSession(): アクティブなセッションを終了します

この API を使用する場合は、次の手順を実行する必要があります。

• 当該のセッションで実行したい各操作に、セッション インスタンスを渡します。

• catch ブロックを実装して、サーバー トランザクション エラーを識別し、エラー処理ロジックを実装します。

次のコードは、Core API を使用してトランザクションを実行する方法を示しています。

async function coreTest(client) {
  const session = client.startSession();
  try {
    session.startTransaction();
    const savingsColl = client.db("bank").collection("savings_accounts");
    await savingsColl.findOneAndUpdate(
      {account_id: "9876"}, 
      {$inc: {amount: -100 }}, 
      { session });
    const checkingColl = client.db("bank").collection("checking_accounts");
    await checkingColl.findOneAndUpdate(
      {account_id: "9876"}, 
      {$inc: {amount: 100 }}, 
      { session });
    // ... perform other operations
    await session.commitTransaction();
    console.log("Transaction committed.");
  } catch (error) {
    console.log("An error occurred during the transaction:" + error);
    await session.abortTransaction();
  } finally {
    await session.endSession();
  }
}

const session = client1.startSession();
client2.db('myDB').collection('myColl').insertOne({ name: 'Jane Eyre' }, { session });

この API を使用する完全に実行可能な使用例については、「Core API の使用」を参照してください。

Convenient Transaction API

Convenient Transaction API には、トランザクションを実装するための次のメソッドが用意されています。

• withSession(): セッション内で渡されたコールバックを実行します。API はセッションの作成と終了を自動的に処理します。

• withTransaction() : トランザクション内で渡されたコールバックを実行し、コールバックが返されたときにcommitTransaction() メソッドを呼び出します。

これらのメソッドは、コールバックで返された値を返します。たとえば、withTransaction() メソッドに渡したコールバックがドキュメント { hello: "world" } を返す場合、withTransaction() メソッドもそのドキュメントを返します。

Convenient Transaction API を使用すると、コールバックからの戻り値を withTransaction() メソッドと withSession() メソッドの戻り値として伝達し、コードの他の場所で処理できます。

この API を使用する場合は、次の手順を実行する必要があります。

• 当該のセッションで実行したい各操作に、セッション インスタンスを渡します。

• セッションの各操作に対して非同期 await 構文を実装します。

• Promise.all()メソッドを呼び出すなどの並列処理は避けます。セッションを並行して使用すると、通常はサーバー エラーが発生します。

次のコードは、 Convenient Transaction API を使用してトランザクションを実行する方法を示しています。

async function convTest(client) {
  let txnRes = await client.withSession(async (session) =>
    session.withTransaction(async (session) => {
      const savingsColl = client.db("bank").collection("savings_accounts");
      await savingsColl.findOneAndUpdate(
        {account_id: "9876"}, 
        {$inc: {amount: -100 }}, 
        { session });
  
      const checkingColl = client.db("bank").collection("checking_accounts");
      await checkingColl.findOneAndUpdate(
        {account_id: "9876"}, 
        {$inc: {amount: 100 }}, 
        { session });
      // ... perform other operations
      return "Transaction committed.";
    }, null)
  );
  console.log(txnRes);
}

この API を使用する完全に実行可能な使用例を確認するには、「Convenient Transaction API の使用」使用例を参照してください。

Convenient Transaction APIエラー処理

Convenient Transaction API には、これらのエラー タイプに対応する再試行ロジックが組み込まれています。ドライバーは、コミットが成功するまでトランザクションを自動的に再試行します。

Core APIエラー処理

Core APIを使用してトランザクションを実行している場合は、次のエラー処理関数をアプリケーションに追加する 必要があります。

• ドライバが TransientTransactionError

• ドライバーが UnknownTransactionCommitResult

これらの関数は、コミットが成功するか、別のエラーが発生するまで実行する必要があります。この再試行ロジックの例については、サーバー マニュアルのドライバーAPIページの 「Core API」セクション を参照してください。