1. drupal
    1. 8
    2. 7

A wrapper class for creating and managing database transactions.

Not all databases or database configurations support transactions. For example, MySQL MyISAM tables do not. It is also easy to begin a transaction and then forget to commit it, which can lead to connection errors when another transaction is started.

This class acts as a wrapper for transactions. To begin a transaction, simply instantiate it. When the object goes out of scope and is destroyed it will automatically commit. It also will check to see if the specified connection supports transactions. If not, it will simply skip any transaction commands, allowing user-space code to proceed normally. The only difference is that rollbacks won't actually do anything.

In the vast majority of cases, you should not instantiate this class directly. Instead, call ->startTransaction(), from the appropriate connection object.



DatabaseTransaction::$connectionThe connection object for this transaction.
DatabaseTransaction::$rolledBackA boolean value to indicate whether this transaction has been rolled back.

Functions & methods

DatabaseTransaction::nameRetrieves the name of the transaction or savepoint.
DatabaseTransaction::rollbackRolls back the current transaction.

includes/database/, line 1827

View source
class DatabaseTransaction {

   * The connection object for this transaction.
   * @var DatabaseConnection
  protected $connection;

   * A boolean value to indicate whether this transaction has been rolled back.
   * @var Boolean
  protected $rolledBack = FALSE;

   * The name of the transaction.
   * This is used to label the transaction savepoint. It will be overridden to
   * 'drupal_transaction' if there is no transaction depth.
  protected $name;

  public function __construct(DatabaseConnection &$connection, $name = NULL) {
    $this->connection = &$connection;
    // If there is no transaction depth, then no transaction has started. Name
    // the transaction 'drupal_transaction'.
    if (!$depth = $connection->transactionDepth()) {
      $this->name = 'drupal_transaction';
    // Within transactions, savepoints are used. Each savepoint requires a
    // name. So if no name is present we need to create one.
    elseif (!$name) {
      $this->name = 'savepoint_' . $depth;
    else {
      $this->name = $name;

  public function __destruct() {
    // If we rolled back then the transaction would have already been popped.
    if (!$this->rolledBack) {

   * Retrieves the name of the transaction or savepoint.
  public function name() {
    return $this->name;

   * Rolls back the current transaction.
   * This is just a wrapper method to rollback whatever transaction stack we are
   * currently in, which is managed by the connection object itself. Note that
   * logging (preferable with watchdog_exception()) needs to happen after a
   * transaction has been rolled back or the log messages will be rolled back
   * too.
   * @see DatabaseConnection::rollback()
   * @see watchdog_exception()
  public function rollback() {
    $this->rolledBack = TRUE;

Related topics