MongoDB\Driver\Session::commitTransaction
(mongodb >=1.5.0)
MongoDB\Driver\Session::commitTransaction — Commits a transaction
Description
Saves the changes made by the operations in the multi-document transaction and ends the transaction. Until the commit, none of the data changes made from within the transaction are visible outside the transaction.
Parameters
This function has no parameters.
Return Values
No value is returned.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws
MongoDB\Driver\Exception\CommandException if the
server could not commit the transaction (e.g. due to conflicts, network
issues). In case the exception's
MongoDB\Driver\Exception\CommandException::getResultDocument()
has a
"errorLabels"element, and this array contains a"TransientTransactionError"or"UnUnknownTransactionCommitResult"value, it is safe to re-try the whole transaction. In newer versions of the driver, MongoDB\Driver\Exception\RuntimeException::hasErrorLabel() should be used to test for this situation instead. - Throws MongoDB\Driver\Exception\RuntimeException if the transaction could not be commited (e.g. a transaction was not started).
See Also
- MongoDB\Driver\Manager::startSession() - Start a new client session for use with this client
- MongoDB\Driver\Session::abortTransaction() - Aborts a transaction
- MongoDB\Driver\Session::startTransaction() - Starts a transaction
- MongoDB\Driver\Exception\RuntimeException::hasErrorLabel() - Returns whether an error label is associated with an exception
add a note
User Contributed Notes
There are no user contributed notes for this page.
