cuberite/SQLiteCpp
1
0
Fork 0
mirror of https://github.com/cuberite/SQLiteCpp.git synced 2025-08-07 03:06:05 -04:00
Code Issues Packages Projects Releases Wiki Activity

Small improvements & code cleanup

Browse Source
This commit is contained in:
Kacperos155 2022-07-23 16:07:53 +02:00
parent 9158225e5d
commit be5400ca99
10 changed files with 54 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/SQLiteCpp/Backup.h
View File

@ -14,6 +14,7 @@
#include <SQLiteCpp/Database.h>
#include <string>
#include <memory>
// Forward declaration to avoid inclusion of <sqlite3.h> in a header
struct sqlite3_backup;
@ -95,9 +96,6 @@ public:
Backup(const Backup&) = delete;
Backup& operator=(const Backup&) = delete;
/// Release the SQLite Backup resource.
~Backup();
/**
* @brief Execute a step of backup with a given number of source pages to be copied
*
@ -114,14 +112,19 @@ public:
int executeStep(const int aNumPage = -1);
/// Return the number of source pages still to be backed up as of the most recent call to executeStep().
int getRemainingPageCount();
int getRemainingPageCount() const;
/// Return the total number of pages in the source database as of the most recent call to executeStep().
int getTotalPageCount();
int getTotalPageCount() const;
private:
// TODO: use std::unique_ptr with a custom deleter to call sqlite3_backup_finish()
sqlite3_backup* mpSQLiteBackup = nullptr; ///< Pointer to SQLite Database Backup Handle
// Deleter functor to use with smart pointers to close the SQLite database backup in an RAII fashion.
struct Deleter
{
void operator()(sqlite3_backup* apBackup);
};
std::unique_ptr<sqlite3_backup, Deleter> mpSQLiteBackup{}; ///< Pointer to SQLite Database Backup Handle
};
} // namespace SQLite

10
include/SQLiteCpp/Database.h
View File

@ -78,7 +78,7 @@ extern const int OPEN_NOFOLLOW; // SQLITE_OPEN_NOFOLLOW
extern const int OK; ///< SQLITE_OK (used by check() bellow)
extern const char* VERSION; ///< SQLITE_VERSION string from the sqlite3.h used at compile time
extern const char* const VERSION; ///< SQLITE_VERSION string from the sqlite3.h used at compile time
extern const int VERSION_NUMBER; ///< SQLITE_VERSION_NUMBER from the sqlite3.h used at compile time
/// Return SQLite version string using runtime call to the compiled library
@ -328,7 +328,7 @@ public:
*
* @return the sqlite result code.
*/
int tryExec(const std::string aQueries) noexcept
int tryExec(const std::string& aQueries) noexcept
{
return tryExec(aQueries.c_str());
}
@ -389,7 +389,7 @@ public:
*
* @throw SQLite::Exception in case of error
*/
bool tableExists(const char* apTableName);
bool tableExists(const char* apTableName) const;
/**
* @brief Shortcut to test if a table exists.
@ -402,7 +402,7 @@ public:
*
* @throw SQLite::Exception in case of error
*/
bool tableExists(const std::string& aTableName)
bool tableExists(const std::string& aTableName) const
{
return tableExists(aTableName.c_str());
}
@ -552,7 +552,7 @@ public:
static Header getHeaderInfo(const std::string& aFilename);
// Parse SQLite header data from a database file.
Header getHeaderInfo()
Header getHeaderInfo() const
{
return getHeaderInfo(mFilename);
}

4
include/SQLiteCpp/Savepoint.h
View File

@ -66,7 +66,7 @@ class Savepoint {
* Exception is thrown in case of error, then the Savepoint is NOT
* initiated.
*/
Savepoint(Database& aDatabase, std::string name);
Savepoint(Database& aDatabase, const std::string& name);
// Savepoint is non-copyable
Savepoint(const Savepoint&) = delete;
@ -90,6 +90,6 @@ class Savepoint {
private:
Database& mDatabase; ///< Reference to the SQLite Database Connection
std::string msName; ///< Name of the Savepoint
bool mbReleased; ///< True when release has been called
bool mbReleased{ false }; ///< True when release has been called
};
} // namespace SQLite

12
include/SQLiteCpp/Statement.h
View File

@ -74,18 +74,14 @@ public:
Statement(aDatabase, aQuery.c_str())
{}
/**
* @brief Move an SQLite statement.
*
* @param[in] aStatement Statement to move
*/
Statement(Statement&& aStatement) noexcept;
Statement& operator=(Statement&& aStatement) noexcept = default;
// Statement is non-copyable
Statement(const Statement&) = delete;
Statement& operator=(const Statement&) = delete;
Statement(Statement&& aStatement) noexcept;
Statement& operator=(Statement&& aStatement) noexcept = default;
// TODO: Change Statement move constructor to default
/// Finalize and unregister the SQL query from the SQLite Database Connection.
/// The finalization will be done by the destructor of the last shared pointer
~Statement() = default;

2
include/SQLiteCpp/Transaction.h
View File

@ -88,7 +88,7 @@ public:
private:
Database& mDatabase; ///< Reference to the SQLite Database Connection
bool mbCommited; ///< True when commit has been called
bool mbCommited{ false }; ///< True when commit has been called
};

32
src/Backup.cpp
View File

@ -24,10 +24,10 @@ Backup::Backup(Database& aDestDatabase,
Database& aSrcDatabase,
const char* apSrcDatabaseName)
{
mpSQLiteBackup = sqlite3_backup_init(aDestDatabase.getHandle(),
mpSQLiteBackup.reset(sqlite3_backup_init(aDestDatabase.getHandle(),
apDestDatabaseName,
aSrcDatabase.getHandle(),
apSrcDatabaseName);
apSrcDatabaseName));
if (nullptr == mpSQLiteBackup)
{
// If an error occurs, the error code and message are attached to the destination database connection.
@ -48,19 +48,10 @@ Backup::Backup(Database &aDestDatabase, Database &aSrcDatabase) :
{
}
// Release resource for SQLite database backup
Backup::~Backup()
{
if (mpSQLiteBackup)
{
sqlite3_backup_finish(mpSQLiteBackup);
}
}
// Execute backup step with a given number of source pages to be copied
int Backup::executeStep(const int aNumPage /* = -1 */)
{
const int res = sqlite3_backup_step(mpSQLiteBackup, aNumPage);
const int res = sqlite3_backup_step(mpSQLiteBackup.get(), aNumPage);
if (SQLITE_OK != res && SQLITE_DONE != res && SQLITE_BUSY != res && SQLITE_LOCKED != res)
{
throw SQLite::Exception(sqlite3_errstr(res), res);
@ -69,15 +60,24 @@ int Backup::executeStep(const int aNumPage /* = -1 */)
}
// Get the number of remaining source pages to be copied in this backup process
int Backup::getRemainingPageCount()
int Backup::getRemainingPageCount() const
{
return sqlite3_backup_remaining(mpSQLiteBackup);
return sqlite3_backup_remaining(mpSQLiteBackup.get());
}
// Get the number of total source pages to be copied in this backup process
int Backup::getTotalPageCount()
int Backup::getTotalPageCount() const
{
return sqlite3_backup_pagecount(mpSQLiteBackup);
return sqlite3_backup_pagecount(mpSQLiteBackup.get());
}
// Release resource for SQLite database backup
void SQLite::Backup::Deleter::operator()(sqlite3_backup* apBackup)
{
if (apBackup)
{
sqlite3_backup_finish(apBackup);
}
}
} // namespace SQLite

11
src/Database.cpp
View File

@ -27,6 +27,7 @@
namespace SQLite
{
const int OK = SQLITE_OK;
const int OPEN_READONLY = SQLITE_OPEN_READONLY;
const int OPEN_READWRITE = SQLITE_OPEN_READWRITE;
const int OPEN_CREATE = SQLITE_OPEN_CREATE;
@ -42,9 +43,7 @@ const int OPEN_NOFOLLOW = SQLITE_OPEN_NOFOLLOW;
const int OPEN_NOFOLLOW = 0;
#endif
const int OK = SQLITE_OK;
const char* VERSION = SQLITE_VERSION;
const char* const VERSION = SQLITE_VERSION;
const int VERSION_NUMBER = SQLITE_VERSION_NUMBER;
// Return SQLite version string using runtime call to the compiled library
@ -142,7 +141,7 @@ Column Database::execAndGet(const char* apQuery)
}
// Shortcut to test if a table exists.
bool Database::tableExists(const char* apTableName)
bool Database::tableExists(const char* apTableName) const
{
Statement query(*this, "SELECT count(*) FROM sqlite_master WHERE type='table' AND name=?");
query.bind(1, apTableName);
@ -439,8 +438,8 @@ void Database::backup(const char* apFilename, BackupType aType)
Database otherDatabase(apFilename, SQLite::OPEN_READWRITE | SQLite::OPEN_CREATE);
// For a 'Save' operation, data is copied from the current Database to the other. A 'Load' is the reverse.
Database& src = (aType == Save ? *this : otherDatabase);
Database& dest = (aType == Save ? otherDatabase : *this);
Database& src = (aType == BackupType::Save ? *this : otherDatabase);
Database& dest = (aType == BackupType::Save ? otherDatabase : *this);
// Set up the backup procedure to copy between the "main" databases of each connection
Backup bkp(dest, src);

4
src/Savepoint.cpp
View File

@ -18,8 +18,8 @@
namespace SQLite {
// Begins the SQLite savepoint
Savepoint::Savepoint(Database& aDatabase, std::string aName)
: mDatabase(aDatabase), msName(aName), mbReleased(false) {
Savepoint::Savepoint(Database& aDatabase, const std::string& aName)
: mDatabase(aDatabase), msName(aName) {
// workaround because you cannot bind to SAVEPOINT
// escape name for use in query
Statement stmt(mDatabase, "SELECT quote(?)");

6
src/Transaction.cpp
View File

@ -21,8 +21,7 @@ namespace SQLite
// Begins the SQLite transaction
Transaction::Transaction(Database& aDatabase, TransactionBehavior behavior) :
mDatabase(aDatabase),
mbCommited(false)
mDatabase(aDatabase)
{
const char *stmt;
switch (behavior) {
@ -43,8 +42,7 @@ Transaction::Transaction(Database& aDatabase, TransactionBehavior behavior) :
// Begins the SQLite transaction
Transaction::Transaction(Database &aDatabase) :
mDatabase(aDatabase),
mbCommited(false)
mDatabase(aDatabase)
{
mDatabase.exec("BEGIN");
}