sqlite::v2::savepoint Struct Reference

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

#include <savepoint.hpp>

Collaboration diagram for sqlite::v2::savepoint:

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.
snapshot	take_snapshot (std::string_view schema="main")
void	open_snapshot (snapshot const &snap, std::string_view schema="main")

Private Member Functions
void	exec (std::string const &)

Private Attributes
connection &	m_con
	SQlite connection handler.
std::string	m_name
	The alias for the savepoint.
bool	m_isActive

Detailed Description

this is a helper class to handle transaction savepoints within SQLite

Definition at line 52 of file savepoint.hpp.

Constructor & Destructor Documentation

savepoint()

sqlite::v2::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

~savepoint()

sqlite::v2::savepoint::~savepoint

(

)

destructor

Member Function Documentation

exec()

void sqlite::v2::savepoint::exec ( std::string const & )

private

getName()

std::string sqlite::v2::savepoint::getName ( ) const

inline

Returns a string containing the current savepoint name.

Returns

The alias of savepoint handled by this object

Definition at line 91 of file savepoint.hpp.

References m_name.

isActive()

bool sqlite::v2::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 84 of file savepoint.hpp.

References m_isActive.

open_snapshot()

void sqlite::v2::savepoint::open_snapshot	(	snapshot const &	snap,
		std::string_view	schema = "main" )

release()

void sqlite::v2::savepoint::release

(

)

Releases a previously created savepoint.

rollback()

void sqlite::v2::savepoint::rollback

(

)

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

take_snapshot()

snapshot sqlite::v2::savepoint::take_snapshot

(

std::string_view

schema = "main"

)

Member Data Documentation

m_con

connection& sqlite::v2::savepoint::m_con

private

SQlite connection handler.

Definition at line 101 of file savepoint.hpp.

m_isActive

bool sqlite::v2::savepoint::m_isActive

private

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

Definition at line 103 of file savepoint.hpp.

Referenced by isActive().

m_name

std::string sqlite::v2::savepoint::m_name

private

The alias for the savepoint.

Definition at line 102 of file savepoint.hpp.

Referenced by getName().

---

The documentation for this struct was generated from the following file:

• include/sqlite/savepoint.hpp