MongoDB\Driver\Session::isInTransaction

Returns whether a multi-document transaction is in progress

Description

final public bool MongoDB\Driver\Session::isInTransaction()

Returns whether a multi-document transaction is currently in progress for this session. A transaction is considered "in progress" if it has been started but has not been committed or aborted.

Parameters

This function has no parameters.

Return Values

Returns true if a transaction is currently in progress for this session, and false otherwise.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

See Also

  • MongoDB\Driver\Session::getTransactionState