RAII class that provides access to a WalletDatabase. More...

#include <sqlite.h>

Inheritance diagram for wallet::SQLiteBatch:

Collaboration diagram for wallet::SQLiteBatch:

Public Member Functions
	SQLiteBatch (SQLiteDatabase &database)

	~SQLiteBatch () override

void	SetExecHandler (std::unique_ptr< SQliteExecHandler > &&handler)

void	Close () override

std::unique_ptr< DatabaseCursor >	GetNewCursor () override

std::unique_ptr< DatabaseCursor >	GetNewPrefixCursor (std::span< const std::byte > prefix) override

bool	TxnBegin () override

bool	TxnCommit () override

bool	TxnAbort () override

bool	HasActiveTxn () override

Public Member Functions inherited from wallet::DatabaseBatch
	DatabaseBatch ()=default

virtual	~DatabaseBatch ()=default

	DatabaseBatch (const DatabaseBatch &)=delete

DatabaseBatch &	operator= (const DatabaseBatch &)=delete

virtual void	Close ()=0

template<typename K , typename T >
bool	Read (const K &key, T &value)

template<typename K , typename T >
bool	Write (const K &key, const T &value, bool fOverwrite=true)

template<typename K >
bool	Erase (const K &key)

template<typename K >
bool	Exists (const K &key)

virtual bool	ErasePrefix (std::span< const std::byte > prefix)=0

virtual std::unique_ptr< DatabaseCursor >	GetNewCursor ()=0

virtual std::unique_ptr< DatabaseCursor >	GetNewPrefixCursor (std::span< const std::byte > prefix)=0

virtual bool	TxnBegin ()=0

virtual bool	TxnCommit ()=0

virtual bool	TxnAbort ()=0

virtual bool	HasActiveTxn ()=0

Private Member Functions
void	SetupSQLStatements ()

bool	ExecStatement (sqlite3_stmt *stmt, std::span< const std::byte > blob)

bool	ReadKey (DataStream &&key, DataStream &value) override

bool	WriteKey (DataStream &&key, DataStream &&value, bool overwrite=true) override

bool	EraseKey (DataStream &&key) override

bool	HasKey (DataStream &&key) override

bool	ErasePrefix (std::span< const std::byte > prefix) override

Private Attributes
SQLiteDatabase &	m_database

std::unique_ptr< SQliteExecHandler >	m_exec_handler {std::make_unique<SQliteExecHandler>()}

sqlite3_stmt *	m_read_stmt {nullptr}

sqlite3_stmt *	m_insert_stmt {nullptr}

sqlite3_stmt *	m_overwrite_stmt {nullptr}

sqlite3_stmt *	m_delete_stmt {nullptr}

sqlite3_stmt *	m_delete_prefix_stmt {nullptr}

bool	m_txn {false}
	Whether this batch has started a database transaction and whether it owns SQLiteDatabase::m_write_semaphore. More...

Detailed Description

RAII class that provides access to a WalletDatabase.

Definition at line 51 of file sqlite.h.

Constructor & Destructor Documentation

◆ SQLiteBatch()

wallet::SQLiteBatch::SQLiteBatch ( SQLiteDatabase & database )

explicit

Definition at line 396 of file sqlite.cpp.

Here is the call graph for this function:

◆ ~SQLiteBatch()

wallet::SQLiteBatch::~SQLiteBatch ( )

inlineoverride

Definition at line 86 of file sqlite.h.

Here is the call graph for this function:

Member Function Documentation

◆ Close()

void wallet::SQLiteBatch::Close ( )

overridevirtual

Implements wallet::DatabaseBatch.

Definition at line 405 of file sqlite.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EraseKey()

bool wallet::SQLiteBatch::EraseKey ( DataStream && key )

overrideprivatevirtual

Implements wallet::DatabaseBatch.

Definition at line 537 of file sqlite.cpp.

Here is the call graph for this function:

◆ ErasePrefix()

bool wallet::SQLiteBatch::ErasePrefix ( std::span< const std::byte > prefix )

overrideprivatevirtual

Implements wallet::DatabaseBatch.

Definition at line 542 of file sqlite.cpp.

Here is the call graph for this function:

◆ ExecStatement()

bool wallet::SQLiteBatch::ExecStatement	(	sqlite3_stmt *	stmt,
		std::span< const std::byte >	blob
	)

private

Definition at line 513 of file sqlite.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNewCursor()

std::unique_ptr< DatabaseCursor > wallet::SQLiteBatch::GetNewCursor ( )

overridevirtual

Implements wallet::DatabaseBatch.

Definition at line 591 of file sqlite.cpp.

◆ GetNewPrefixCursor()

std::unique_ptr< DatabaseCursor > wallet::SQLiteBatch::GetNewPrefixCursor ( std::span< const std::byte > prefix )

overridevirtual

Implements wallet::DatabaseBatch.

Definition at line 606 of file sqlite.cpp.

Here is the call graph for this function:

◆ HasActiveTxn()

bool wallet::SQLiteBatch::HasActiveTxn ( )

inlineoverridevirtual

Implements wallet::DatabaseBatch.

Definition at line 97 of file sqlite.h.

◆ HasKey()

bool wallet::SQLiteBatch::HasKey ( DataStream && key )

overrideprivatevirtual

Implements wallet::DatabaseBatch.

Definition at line 547 of file sqlite.cpp.

Here is the call graph for this function:

◆ ReadKey()

bool wallet::SQLiteBatch::ReadKey	(	DataStream &&	key,
		DataStream &	value
	)

overrideprivatevirtual

Implements wallet::DatabaseBatch.

Definition at line 454 of file sqlite.cpp.

Here is the call graph for this function:

◆ SetExecHandler()

void wallet::SQLiteBatch::SetExecHandler ( std::unique_ptr< SQliteExecHandler > && handler )

inline

Definition at line 88 of file sqlite.h.

◆ SetupSQLStatements()

void wallet::SQLiteBatch::SetupSQLStatements ( )

private

Definition at line 146 of file sqlite.cpp.

Here is the caller graph for this function:

◆ TxnAbort()

bool wallet::SQLiteBatch::TxnAbort ( )

overridevirtual

Implements wallet::DatabaseBatch.

Definition at line 677 of file sqlite.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TxnBegin()

bool wallet::SQLiteBatch::TxnBegin ( )

overridevirtual

Implements wallet::DatabaseBatch.

Definition at line 648 of file sqlite.cpp.

Here is the call graph for this function:

◆ TxnCommit()

bool wallet::SQLiteBatch::TxnCommit ( )

overridevirtual

Implements wallet::DatabaseBatch.

Definition at line 663 of file sqlite.cpp.

Here is the call graph for this function:

◆ WriteKey()

bool wallet::SQLiteBatch::WriteKey	(	DataStream &&	key,
		DataStream &&	value,
		bool	overwrite = `true`
	)

overrideprivatevirtual

Implements wallet::DatabaseBatch.

Definition at line 480 of file sqlite.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ m_database

SQLiteDatabase& wallet::SQLiteBatch::m_database

private

Definition at line 54 of file sqlite.h.

◆ m_delete_prefix_stmt

sqlite3_stmt* wallet::SQLiteBatch::m_delete_prefix_stmt {nullptr}

private

Definition at line 61 of file sqlite.h.

◆ m_delete_stmt

sqlite3_stmt* wallet::SQLiteBatch::m_delete_stmt {nullptr}

private

Definition at line 60 of file sqlite.h.

◆ m_exec_handler

std::unique_ptr<SQliteExecHandler> wallet::SQLiteBatch::m_exec_handler {std::make_unique<SQliteExecHandler>()}

private

Definition at line 55 of file sqlite.h.

◆ m_insert_stmt

sqlite3_stmt* wallet::SQLiteBatch::m_insert_stmt {nullptr}

private

Definition at line 58 of file sqlite.h.

◆ m_overwrite_stmt

sqlite3_stmt* wallet::SQLiteBatch::m_overwrite_stmt {nullptr}

private

Definition at line 59 of file sqlite.h.

◆ m_read_stmt

sqlite3_stmt* wallet::SQLiteBatch::m_read_stmt {nullptr}

private

Definition at line 57 of file sqlite.h.

◆ m_txn

bool wallet::SQLiteBatch::m_txn {false}

private

Whether this batch has started a database transaction and whether it owns SQLiteDatabase::m_write_semaphore.

If the batch starts a db tx, it acquires the semaphore and sets this to true, keeping the semaphore until the transaction ends to prevent other batch objects from writing to the database.

If this batch did not start a transaction, the semaphore is acquired transiently when writing and m_txn is not set.

m_txn is different from HasActiveTxn() as it is only true when this batch has started the transaction, not just when any batch has started a transaction.

Definition at line 73 of file sqlite.h.

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

src/wallet/sqlite.h
src/wallet/sqlite.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SQLiteBatch()

◆ ~SQLiteBatch()

Member Function Documentation

◆ Close()

◆ EraseKey()

◆ ErasePrefix()

◆ ExecStatement()

◆ GetNewCursor()

◆ GetNewPrefixCursor()

◆ HasActiveTxn()

◆ HasKey()

◆ ReadKey()

◆ SetExecHandler()

◆ SetupSQLStatements()

◆ TxnAbort()

◆ TxnBegin()

◆ TxnCommit()

◆ WriteKey()

Member Data Documentation

◆ m_database

◆ m_delete_prefix_stmt

◆ m_delete_stmt

◆ m_exec_handler

◆ m_insert_stmt

◆ m_overwrite_stmt

◆ m_read_stmt

◆ m_txn