Edit Report a Bug

    PDO::rollBack

    (PHP 5 >= 5.1.0, PHP 7, PHP 8, PECL pdo >= 0.1.0)

    PDO::rollBack — Rolls back a transaction

    Description

    public PDO::rollBack(): bool

    Rolls back the current transaction, as initiated by PDO::beginTransaction().

    If the database was set to autocommit mode, this function will restore autocommit mode after it has rolled back the transaction.

    Some databases, including MySQL, automatically issue an implicit COMMIT when a database definition language (DDL) statement such as DROP TABLE or CREATE TABLE is issued within a transaction. The implicit COMMIT will prevent you from rolling back any other changes within the transaction boundary.

    Parameters

    This function has no parameters.

    Return Values

    Returns true on success or false on failure.

    Errors/Exceptions

    Throws a PDOException if there is no active transaction.

    Note: An exception is raised even when the PDO::ATTR_ERRMODE attribute is not PDO::ERRMODE_EXCEPTION.

    Examples

    Example #1 Roll back a transaction

    The following example begins a transaction and issues two statements that modify the database before rolling back the changes. On MySQL, however, the DROP TABLE statement automatically commits the transaction so that none of the changes in the transaction are rolled back.

    <?php
    /* Begin a transaction, turning off autocommit */
    $dbh->beginTransaction();

    /* Change the database schema and data */
    $sth = $dbh->exec("DROP TABLE fruit");
    $sth = $dbh->exec("UPDATE dessert
    SET name = 'hamburger'"    );

    /* Recognize mistake and roll back changes */
    $dbh->rollBack();

    /* Database connection is now back in autocommit mode */
    ?>

    See Also

    add a note add a note

    User Contributed Notes 4 notes

    up
    53
    JonasJ
    16 years ago
    Just a quick (and perhaps obvious) note for MySQL users;

    Don't scratch your head if it isn't working if you are using a MyISAM table to test the rollbacks with.

    Both rollBack() and beginTransaction() will return TRUE but the rollBack will not happen.

    Convert the table to InnoDB and run the test again.
    up
    11
    brian at diamondsea dot com
    16 years ago
    Here is a way of testing that your transaction has started when using MySQL's InnoDB tables.  It will fail if you are using MySQL's MyISAM tables, which do not support transactions but will also not return an error when using them.

    <?
    // Begin the transaction
    $dbh->beginTransaction();

    // To verify that a transaction has started, try to create an (illegal for InnoDB) nested transaction.
    //    If it works, the first transaction did not start correctly or is unsupported (such as on MyISAM tables)
    try {
            $dbh->beginTransaction();
        die(    'Cancelling, Transaction was not properly started');
    } catch (    PDOException $e) {
        print     "Transaction is running (because trying another one failed)\n";
    }
    ?>
    up
    5
    Petros Giakouvakis
    14 years ago
    Should anyone reading this be slightly panicked because they just discovered that their MySQL  tables are MyIsam and not InnoDb, don't worry... You can very easily change the storage engine using the following query:

    ALTER TABLE your_table_name ENGINE = innodb;
    up
    -6
    linfo2003 at libero dot it
    17 years ago
    Since "It is an error to call this method if no transaction is active", it could be useful (even if not indispensable) to have a method which returns true if a transaction is active.

    try {
        $dbh->beginTransaction();
        ...
    } catch (PDOException $e) {
        if ($dbh->isTransactionActive())  // this function does NOT exist
            $dbh->rollBack();
        ...
    }

    In the meanwhile, I'm using this code:

        ...
    } catch (PDOException $e) {
        try { $dbh->rollBack(); } catch (Exception $e2) {}
        ...
    }

    It's not so chic, but it works fine.
    add a note add a note
    To Top