Wt  3.3.9
Public Member Functions | List of all members
Wt::Dbo::Transaction Class Reference

A database transaction. More...

#include <Wt/Dbo/Transaction>

Inherited by Wt::Auth::Dbo::UserDatabase< DboType >::TransactionImpl.

Public Member Functions

 Transaction (Session &session)
 Constructor. More...
 
virtual ~Transaction () WT_CXX11ONLY(noexcept(false))
 Destructor. More...
 
bool isActive () const
 Returns whether the transaction is still active. More...
 
bool commit ()
 Commits the transaction. More...
 
void rollback ()
 Rolls back the transaction. More...
 
Sessionsession () const
 Returns the session associated with this transaction. More...
 
SqlConnectionconnection () const
 Returns the connection used by this transaction.
 

Detailed Description

A database transaction.

This class implements a RAII transaction. Most dbo manipulations require that a transaction is active, and database changes will not be committed to the database until the active transaction is committed. A transaction can be committed using commit(), but also commits automatically when it is deleted while no exception is being thrown (using std::uncaught_exception()). This means that it is possible that the transaction destructor throws an exception in case the transaction still needs to be committed, and the commit fails. If the transaction is deleted because of stack unwinding while an exception is thrown, then the transaction rolls back.

A transaction is active until it is either committed or rolled back. When a transaction is rolled back or fails, the modified database objects are not successfully synchronized with the database. A roll-back does not affect the value of the in memory database objects, so they may possibly be synchronized later in a new transaction or discarded using Session::rereadAll().

In most occasions you will want to guard any method that touches the database using a transaction object on the stack.

But you may create multiple (nested) transaction objects at the same time: in this way you can guard a method with a transaction object even if it is called from another method which also defines a transaction at a wider scope. Nested transactions act in concert and reference the same logical transaction: the logical transaction will fail if at least one transaction fails, and will be committed only if all transactions are committed.

Usage example:

void doSomething(Wt::Dbo::Session& session)
{
Wt::Dbo::Transaction transaction(session);
Wt::Dbo::ptr<Account> a = session.load<Account>(42);
...
// the transaction will roll back if an exception is thrown, or
// commit otherwise
}

Constructor & Destructor Documentation

Wt::Dbo::Transaction::Transaction ( Session session)
explicit

Constructor.

Opens a transaction for the given session. If a transaction is already open for the session, this transaction is added. All open transactions must commit successfully for the entire transaction to succeed.

Wt::Dbo::Transaction::~Transaction ( )
virtualnoexcept

Destructor.

If the transaction is still active, it is rolled back.

Member Function Documentation

bool Wt::Dbo::Transaction::commit ( )

Commits the transaction.

If this is the last open transaction for the session, the session is flushed and pending changes are committed to the database.

Returns whether the transaction was flushed to the database (i.e. whether this was indeed the last open transaction).

See also
rollback()
bool Wt::Dbo::Transaction::isActive ( ) const

Returns whether the transaction is still active.

A transaction is active unless it has been committed or rolled back.

While a transaction is active, new transactions for the same session are treated as nested transactions.

void Wt::Dbo::Transaction::rollback ( )

Rolls back the transaction.

The transaction is rolled back (if it was still active), and is no longer active.

See also
commit()
Session & Wt::Dbo::Transaction::session ( ) const

Returns the session associated with this transaction.

See also
Transaction()

Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11