sqlite::savepoint Struct Reference

this is a helper class to handle transaction savepoints within SQLite More...

#include <savepoint.hpp>

Collaboration diagram for sqlite::savepoint:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 savepoint (connection &con, std::string const &name)
 constructor
 ~savepoint ()
 destructor
void release ()
 Releases a previously created savepoint.
void rollback ()
 Roll the database status back to the position of the current saveopint.
bool isActive () const
 Allow to check if savepoint handled by this object is currently active.
std::string getName () const
 Returns a string containing the current savepoint name.

Private Member Functions

void exec (std::string const &)

Private Attributes

connectionm_con
 SQlite connection handler.
std::string m_name
 The alias for the savepoint.
bool m_isActive
 if true the savepoint with alias m_name is still active (not currently released)

Detailed Description

this is a helper class to handle transaction savepoints within SQLite

Definition at line 42 of file savepoint.hpp.


Constructor & Destructor Documentation

sqlite::savepoint::savepoint ( connection con,
std::string const &  name 
)

constructor

Parameters:
con a reference to the connection object where the transaction should be started/ended/committed or rolled back
name alias for the savepoint
sqlite::savepoint::~savepoint (  ) 

destructor


Member Function Documentation

void sqlite::savepoint::exec ( std::string const &   )  [private]
std::string sqlite::savepoint::getName (  )  const [inline]

Returns a string containing the current savepoint name.

Returns:
The alias of savepoint handled by this object

Definition at line 79 of file savepoint.hpp.

References m_name.

bool sqlite::savepoint::isActive (  )  const [inline]

Allow to check if savepoint handled by this object is currently active.

Note:
This dues not make any checks inside SQlite's internal data so if a previously-made savepoint is alredy released or rollbacked (committing or rollbacking also this one) this method will continue to say that the savepoint is active.
Returns:
true if savepoint is still active, false otherwise

Definition at line 74 of file savepoint.hpp.

References m_isActive.

void sqlite::savepoint::release (  ) 

Releases a previously created savepoint.

void sqlite::savepoint::rollback (  ) 

Roll the database status back to the position of the current saveopint.


Member Data Documentation

SQlite connection handler.

Definition at line 83 of file savepoint.hpp.

if true the savepoint with alias m_name is still active (not currently released)

Definition at line 85 of file savepoint.hpp.

Referenced by isActive().

std::string sqlite::savepoint::m_name [private]

The alias for the savepoint.

Definition at line 84 of file savepoint.hpp.

Referenced by getName().


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends

Generated on 29 May 2014 for VSQLite++ by  doxygen 1.6.1