トランザクション

Overview

このガイドでは、Node.js ドライバーを使用してトランザクションを実行する方法を学習できます。トランザクションを使用すると、トランザクション全体がコミットされるまでデータを変更しない一連の操作を実行できます。トランザクション内のいずれかの操作が失敗した場合、ドライバーによってトランザクションがキャンセルされ、変更が反映される前にすべてのデータ変更が破棄されます。この特徴はアトミック性と呼ばれます。

MongoDB の 1 つのドキュメントに対する書込み (write) 操作はすべてアトミックであるため、トランザクションを使用して複数のドキュメントを変更するアトミックな変更を行うことをお勧めします。 この状況ではマルチドキュメントトランザクションが必要になります。 MongoDB は、ドライバーで予期しないエラーが発生した場合でも、トランザクション操作に関係するデータの一貫性が保たれることを保証するため、マルチドキュメントトランザクションはACID に準拠します。

ACID compliance とトランザクションの詳細については、 ACID トランザクションに関するの記事をご覧ください。

MongoDB では、マルチドキュメントトランザクションはクライアント セッション中に実行されます。クライアント セッションは、順番に実行されるよう関連付けられた読み取り操作または書込み操作のグループです。毎回新しいクライアントをインスタンス化するのではなく、クライアントを複数のセッションやトランザクションで再利用することをお勧めします。

majorityの読み取りおよび書込み保証と組み合わせると、ドライバーは操作間の因果一貫性を保証します。 詳細については、サーバー マニュアルの 「クライアント セッションと因果一貫性の保証」 を参照してください。

ドライバーを使用してマルチドキュメントトランザクションを実行する方法の詳細については、このガイドの次のセクションを参照してください。

• トランザクション API

• トランザクションのオプション

• トランザクションのエラー

トランザクション API

このドライバーは、トランザクションを実行するための 2 つの API （Core API および Convenient Transaction API）を提供します。

Core API は、トランザクションを作成、コミット、終了できるフレームワークです。この API を使用する場合は、次のアクションを明示的に実行する必要があります。

• トランザクションを作成、コミット、および終了します。

• トランザクションを実行するセッションを作成および終了します。

• エラー処理ロジックを実装します。

Convenient Transaction API は、トランザクションのコミットや終了の責任を負うことなくトランザクションを実行できるフレームワークです。この 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 });

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);
}

トランザクションのオプション

TransactionOptions インスタンスを startTransaction() メソッドと withTransaction() メソッドに渡して、ドライバーがトランザクションを実行する方法を設定できます。オプションを指定すると、 MongoClientインスタンスに設定したオプションの値が上書きされます。

次の表には、 TransactionOptionsインスタンスで指定できるオプションが含まれています。

オプションの完全なリストについては TransactionOptions の API ドキュメントを参照してください。

次のコードは、トランザクション オプションを定義してstartTransaction()メソッドに渡す方法を示しています。

const txnOpts = {
  readPreference: 'primary',
  readConcern: { level: 'local' },
  writeConcern: { w: 'majority' },
  maxCommitTimeMS: 1000
};
session.startTransaction(txnOpts);

トランザクションのエラー

Core API を使用してトランザクションを実行している場合は、次のエラーに対するエラー処理ロジックをアプリケーションに組み込む必要があります。

• TransientTransactionError: ドライバがトランザクションをコミットする前に書き込み操作でエラーが発生した場合に発生します。 このエラーの詳細については、サーバー マニュアルのドライバー API ページの 「 TransientTransactionError の説明」 を参照してください。

• UnknownTransactionCommitResult: コミット操作でエラーが発生した場合に発生します。 このエラーの詳細については、サーバー マニュアルのドライバー API ページの 「 UnknownTransactionCommitResult の説明」 を参照してください。

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