A wrapper class for creating and managing database transactions.

Not all 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, 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 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.


Expanded class hierarchy of DatabaseTransaction

Related topics


core/includes/database/database.inc, line 1934
Core systems for the database layer.


Contains filters are case sensitive
Namesort ascending Modifiers Type Description
DatabaseTransaction::__destruct public function
DatabaseTransaction::__construct public function
DatabaseTransaction::rollback public function Rolls back the current transaction.
DatabaseTransaction::name public function Retrieves the name of the transaction or savepoint.
DatabaseTransaction::$rolledBack protected property A boolean value to indicate whether this transaction has been rolled back.
DatabaseTransaction::$name protected property The name of the transaction.
DatabaseTransaction::$connection protected property The connection object for this transaction.