Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-1478

Provide Transactions example for Docs

    • Type: Icon: Improvement Improvement
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 3.1.0
    • Affects Version/s: None
    • Component/s: Native

      Hi –
      for the manual – would like to pop in driver examples in
      https://docs.mongodb.com/master/core/transactions/#transactions-and-mongodb-drivers

      We'll have the following example for the mongo shell. If we could get the corresponding driver example

      Note: I've modified in the manual for the shell examples to have the transaction happen in a function updateEmployeeInfo(session) so as not to have that horrible txnAborted flag around – but whatever is good practice for the language of your choice. Let me know if I should update the example here to reflect that.

      
       
      // Start Transactions Intro Example 1
       
      function updateEmployeeInfo(session) {
          employeesCollection = session.getDatabase("hr").employees;
          eventsCollection = session.getDatabase("reporting").events;
       
          session.startTransaction( { readConcern: { level: "snapshot" }, writeConcern: { w: "majority" } } );
       
          try{
              employeesCollection.updateOne( { employee: 3 }, { $set: { status: "Inactive" } } );
              eventsCollection.insertOne( { employee: 3, status: { new: "Inactive", old: "Active" } } );
          } catch (error) {
              print("Caught exception during transaction, aborting.");
              session.abortTransaction();
              throw error;
          }
       
          while (true) {
              try {
                  session.commitTransaction(); // Uses write concern set at transaction start.
                  print("Transaction committed.");
                  break;
              } catch (error) {
                  // Can retry commit
                  if (error.hasOwnProperty("errorLabels") && error.errorLabels.includes("UnknownTransactionCommitResult") ) {
                      print("UnknownTransactionCommitResult, retrying commit operation ...");
                      continue;
                  } else {
                      print("Error during commit ...");
                      throw error;
                  }
             }
          }
      }
      // End Transactions Intro Example 1
       
       
      // Start Transactions Retry Example 1
      function runTransactionWithRetry(txnFunc, session) {
          while (true) {
              try {
                  txnFunc(session);  // performs transaction
                  break;
              } catch (error) {
                  print("Transaction aborted. Caught exception during transaction.");
       
                  // If transient error, retry the whole transaction
                  if ( error.hasOwnProperty("errorLabels") && error.errorLabels.includes( "TransientTransactionError")  ) {
                      print("TransientTransactionError, retrying transaction ...");
                      continue;
                  } else {
                      throw error;
                  }
              }
          }
      }
      // End Transactions Retry Example 1
       
      // Start Transactions Retry Example 2
       
      function commitWithRetry(session) {
          while (true) {
              try {
                  session.commitTransaction(); // Uses write concern set at transaction start.
                  print("Transaction committed.");
                  break;
              } catch (error) {
                  // Can retry commit
                  if (error.hasOwnProperty("errorLabels") && error.errorLabels.includes( "UnknownTransactionCommitResult") ) {
                      print("UnknownTransactionCommitResult, retrying commit operation ...");
                      continue;
                  } else {
                      print("Error during commit ...");
                      throw error;
                  }
             }
          }
      }
      // End Transactions Retry Example 2
       
      // Start Transactions Retry Example 3
       
      function runTransactionWithRetry(txnFunc, session) {
          while (true) {
              try {
                  txnFunc(session);  // performs transaction
                  break;
              } catch (error) {
                  // If transient error, retry the whole transaction
                  if ( error.hasOwnProperty("errorLabels") && error.errorLabels.includes("TransientTransactionError")  ) {
                      print("TransientTransactionError, retrying transaction ...");
                      continue;
                  } else {
                      throw error;
                  }
              }
          }
      }
       
      function commitWithRetry(session) {
          while (true) {
              try {
                  session.commitTransaction(); // Uses write concern set at transaction start.
                  print("Transaction committed.");
                  break;
              } catch (error) {
                  // Can retry commit
                  if (error.hasOwnProperty("errorLabels") && error.errorLabels.includes("UnknownTransactionCommitResult") ) {
                      print("UnknownTransactionCommitResult, retrying commit operation ...");
                      continue;
                  } else {
                      print("Error during commit ...");
                      throw error;
                  }
             }
          }
      }
       
      // Updates two collections in a transactions
       
      function updateEmployeeInfo(session) {
          employeesCollection = session.getDatabase("hr").employees;
          eventsCollection = session.getDatabase("reporting").events;
       
          session.startTransaction( { readConcern: { level: "snapshot" }, writeConcern: { w: "majority" } } );
       
          try{
              employeesCollection.updateOne( { employee: 3 }, { $set: { status: "Inactive" } } );
              eventsCollection.insertOne( { employee: 3, status: { new: "Inactive", old: "Active" } } );
          } catch (error) {
              print("Caught exception during transaction, aborting.");
              session.abortTransaction();
              throw error;
          }
       
          commitWithRetry(session);
      }
       
      // Start a session.
      session = db.getMongo("myRepl/mongodb0.example.net:27017,mongodb1.example.net:27017,mongodb2.example.net:27017").startSession( { mode: "primary" } );
       
      try{
         runTransactionWithRetry(updateEmployeeInfo, session);
      } catch (error) {
         // Do something with error
      } finally {
         session.endSession();
      }
       
      // End Transactions Retry Example 3
      
      

      cc: rathi.gnanasekaran scott.lhommedieu behackett

            Assignee:
            daniel.aprahamian@mongodb.com Daniel Aprahamian (Inactive)
            Reporter:
            rathi.gnanasekaran Rathi Gnanasekaran
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: