LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
LeechCraft::Util::DBLock Class Reference

Provides database transaction lock. More...

#include "dblock.h"

Public Member Functions

 DBLock (const DBLock &)=delete
 
DBLockoperator= (const DBLock &)=delete
 
 DBLock (DBLock &&)=default
 
UTIL_DB_API DBLock (QSqlDatabase &database)
 Constructor. More...
 
UTIL_DB_API ~DBLock ()
 Destructor. More...
 
UTIL_DB_API void Init ()
 Initializes the transaction. More...
 
UTIL_DB_API void Good ()
 Notifies the lock about successful higher-level operations. More...
 

Static Public Member Functions

static UTIL_DB_API void DumpError (const QSqlError &error)
 Dumps the error to the qWarning() stream. More...
 
static UTIL_DB_API void DumpError (const QSqlQuery &query)
 Dumps the error to the qWarning() stream. More...
 
static UTIL_DB_API void Execute (QSqlQuery &query)
 Tries to execute the given query. More...
 

Detailed Description

Provides database transaction lock.

To use the lock, create an instance of it passing a non-const reference to the QSqlDatabase to be guarded. To initialize and start the locking mechanism, call Init(). To notify DBLock that everything is good and the database shouldn't be rolled back, call Good(). Transaction would be either commited or rolled back in class' destructor.

The state could be unusable, usable or correct. Unusable means that the class itself isn't usable, usable means that the class is usable, but the transaction state isn't necesseraly in a correct state, and correct means that the lock class is usable and the transaction state is correct.

Definition at line 62 of file dblock.h.

Constructor & Destructor Documentation

◆ DBLock() [1/3]

LeechCraft::Util::DBLock::DBLock ( const DBLock )
delete

◆ DBLock() [2/3]

LeechCraft::Util::DBLock::DBLock ( DBLock &&  )
default

◆ DBLock() [3/3]

LeechCraft::Util::DBLock::DBLock ( QSqlDatabase &  database)

Constructor.

Constructs the lock and prepares it to work with the database. Creating the lock doesn't begin the transaction. Lock is in usable state after that.

Parameters
[in]databaseNon-const reference to the database to be guarded.

Definition at line 42 of file dblock.cpp.

◆ ~DBLock()

LeechCraft::Util::DBLock::~DBLock ( )

Destructor.

Ends the transaction if the lock is in a correct state. If Good() was called, it commits the transaction, otherwise rolls back.

Definition at line 47 of file dblock.cpp.

Member Function Documentation

◆ DumpError() [1/2]

void LeechCraft::Util::DBLock::DumpError ( const QSqlError &  error)
static

Dumps the error to the qWarning() stream.

Parameters
[in]errorThe error class.

Definition at line 84 of file dblock.cpp.

Referenced by LeechCraft::Util::oral::detail::MakeInserter(), and LeechCraft::Util::RunTextQuery().

+ Here is the caller graph for this function:

◆ DumpError() [2/2]

void LeechCraft::Util::DBLock::DumpError ( const QSqlQuery &  query)
static

Dumps the error to the qWarning() stream.

Parameters
[in]queryThe query that should be dumped.

Definition at line 91 of file dblock.cpp.

◆ Execute()

void LeechCraft::Util::DBLock::Execute ( QSqlQuery &  query)
static

Tries to execute the given query.

If query execution is successful, this function just returns. Otherwise it calls DumpError() to write the error to the logs and throws an exception.

Parameters
[in]queryThe query that should be dumped.

Definition at line 98 of file dblock.cpp.

Referenced by LeechCraft::Util::RunQuery(), and LeechCraft::Util::RunTextQuery().

+ Here is the caller graph for this function:

◆ Good()

void LeechCraft::Util::DBLock::Good ( )

Notifies the lock about successful higher-level operations.

Calling this function makes the lock to commit the transaction upon destruction instead of rolling back.

Definition at line 79 of file dblock.cpp.

◆ Init()

void LeechCraft::Util::DBLock::Init ( )

Initializes the transaction.

Tries to start the transaction. If this wasn't successful, the lock remains in a usable but not correct state.

Exceptions
std::runtime_error

Definition at line 61 of file dblock.cpp.

Referenced by LeechCraft::Util::oral::Migrate().

+ Here is the caller graph for this function:

◆ operator=()

DBLock& LeechCraft::Util::DBLock::operator= ( const DBLock )
delete

The documentation for this class was generated from the following files: