sqlite::v2::backup Struct Reference

backup is a class for representing SQLite backup operations An object of this class is not copyable More...

#include <backup.hpp>

Collaboration diagram for sqlite::v2::backup:

Public Member Functions
	backup (connection &conn_to, connection &conn_from)
	backup constructor
	backup (backup const &)=delete
backup &	operator= (backup const &)=delete
	~backup ()
	backup destructor. The backup operation is automatically finished after the object destructed.
bool	step (int nPage=-1)
	Do a backup step.
void	finish ()
	Finish the backup operation This is used for flushing current backup operation. After this call, the backup object should not be used anymore.

Private Member Functions
sqlite3 *	get_to_handle () const

Private Attributes
sqlite3_backup *	m_pBackup
connection &	m_conn_to

Detailed Description

backup is a class for representing SQLite backup operations An object of this class is not copyable

Definition at line 22 of file backup.hpp.

Constructor & Destructor Documentation

backup() [1/2]

sqlite::v2::backup::backup	(	connection &	conn_to,
		connection &	conn_from )

backup constructor

Parameters

conn_to	takes a reference to the connection object of the destination database
conn_from	takes a reference to the connection object of the source database

Referenced by backup(), and operator=().

backup() [2/2]

sqlite::v2::backup::backup ( backup const & )

delete

References backup().

Here is the call graph for this function:

~backup()

sqlite::v2::backup::~backup

(

)

backup destructor. The backup operation is automatically finished after the object destructed.

Member Function Documentation

finish()

void sqlite::v2::backup::finish

(

)

Finish the backup operation This is used for flushing current backup operation. After this call, the backup object should not be used anymore.

get_to_handle()

sqlite3 * sqlite::v2::backup::get_to_handle ( ) const

private

operator=()

backup & sqlite::v2::backup::operator= ( backup const & )

delete

References backup().

Here is the call graph for this function:

step()

bool sqlite::v2::backup::step

(

int

nPage = -1

)

Do a backup step.

Parameters

nPage

the number of pages to backup in this step. If a negative integer is given, all pages are backuped. If this parameter is omitted, -1 is used.

Member Data Documentation

m_conn_to

connection& sqlite::v2::backup::m_conn_to

private

Definition at line 56 of file backup.hpp.

m_pBackup

sqlite3_backup* sqlite::v2::backup::m_pBackup

private

Definition at line 55 of file backup.hpp.

---

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

• include/sqlite/backup.hpp