GncSqlConnection Class Reference

Encapsulate the connection to the database. More...

#include <gnc-sql-connection.hpp>

Inheritance diagram for GncSqlConnection:

Public Member Functions
virtual	~GncSqlConnection ()=default
	Returns NULL if error.
virtual GncSqlResultPtr	execute_select_statement (const GncSqlStatementPtr &) noexcept=0
virtual int	execute_nonselect_statement (const GncSqlStatementPtr &) noexcept=0
	Returns false if error.
virtual GncSqlStatementPtr	create_statement_from_sql (const std::string &) const noexcept=0
virtual bool	does_table_exist (const std::string &) const noexcept=0
	Returns true if successful.
virtual bool	begin_transaction () noexcept=0
	Returns TRUE if successful, false if error.
virtual bool	rollback_transaction () noexcept=0
	Returns TRUE if successful, FALSE if error.
virtual bool	commit_transaction () noexcept=0
	Returns TRUE if successful, FALSE if error.
virtual bool	create_table (const std::string &, const ColVec &) const noexcept=0
	Returns TRUE if successful, FALSE if error.
virtual bool	create_index (const std::string &, const std::string &, const EntryVec &) const noexcept=0
	Returns TRUE if successful, FALSE if error.
virtual bool	add_columns_to_table (const std::string &, const ColVec &) const noexcept=0
	Returns TRUE if successful, FALSE if error.
virtual std::string	quote_string (const std::string &) const noexcept=0
virtual int	dberror () const noexcept=0
	Get the connection error value.
virtual void	set_error (QofBackendError error, unsigned int repeat, bool retry) noexcept=0
virtual bool	verify () noexcept=0
virtual bool	retry_connection (const char *msg) noexcept=0

Detailed Description

Encapsulate the connection to the database.

This is an abstract class; the implementation is database-specific.

Definition at line 58 of file gnc-sql-connection.hpp.

Member Function Documentation

add_columns_to_table()

virtual bool GncSqlConnection::add_columns_to_table ( const std::string &  , const ColVec &    ) const

pure virtualnoexcept

Returns TRUE if successful, FALSE if error.

Implemented in GncDbiSqlConnection.

begin_transaction()

virtual bool GncSqlConnection::begin_transaction ( )

pure virtualnoexcept

Returns TRUE if successful, false if error.

Implemented in GncDbiSqlConnection.

commit_transaction()

virtual bool GncSqlConnection::commit_transaction ( )

pure virtualnoexcept

Returns TRUE if successful, FALSE if error.

Implemented in GncDbiSqlConnection.

create_index()

virtual bool GncSqlConnection::create_index ( const std::string &  , const std::string &  , const EntryVec &    ) const

pure virtualnoexcept

Returns TRUE if successful, FALSE if error.

Implemented in GncDbiSqlConnection.

create_table()

virtual bool GncSqlConnection::create_table ( const std::string &  , const ColVec &    ) const

pure virtualnoexcept

Returns TRUE if successful, FALSE if error.

Implemented in GncDbiSqlConnection.

dberror()

virtual int GncSqlConnection::dberror ( ) const

pure virtualnoexcept

Get the connection error value.

If not 0 will normally be meaningless outside of implementation code.

Implemented in GncDbiSqlConnection.

does_table_exist()

virtual bool GncSqlConnection::does_table_exist ( const std::string &  ) const

pure virtualnoexcept

Returns true if successful.

Implemented in GncDbiSqlConnection.

execute_nonselect_statement()

virtual int GncSqlConnection::execute_nonselect_statement ( const GncSqlStatementPtr &  )

pure virtualnoexcept

Returns false if error.

Implemented in GncDbiSqlConnection.

rollback_transaction()

virtual bool GncSqlConnection::rollback_transaction ( )

pure virtualnoexcept

Returns TRUE if successful, FALSE if error.

Implemented in GncDbiSqlConnection.

verify()

virtual bool GncSqlConnection::verify ( )

pure virtualnoexcept

Implemented in GncDbiSqlConnection.

---

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

• gnc-sql-connection.hpp