ledger-core
Public Member Functions | Static Public Member Functions | List of all members
ledger::core::api::DatabaseBackend Class Referenceabstract

#include <DatabaseBackend.hpp>

+ Inheritance diagram for ledger::core::api::DatabaseBackend:

Public Member Functions

virtual int32_t getConnectionPoolSize ()=0
 
virtual std::shared_ptr< DatabaseBackendenableQueryLogging (bool enable)=0
 
virtual bool isLoggingEnabled ()=0
 

Static Public Member Functions

static std::shared_ptr< DatabaseBackendgetSqlite3Backend ()
 
static std::shared_ptr< DatabaseBackendcreateBackendFromEngine (const std::shared_ptr< DatabaseEngine > &engine)
 

Detailed Description

Class representing a database backend.

Member Function Documentation

◆ createBackendFromEngine()

std::shared_ptr< api::DatabaseBackend > ledger::core::api::DatabaseBackend::createBackendFromEngine ( const std::shared_ptr< DatabaseEngine > &  engine)
static

Create a database backend instance from the given DatabaseEngine implementation.

◆ enableQueryLogging()

virtual std::shared_ptr<DatabaseBackend> ledger::core::api::DatabaseBackend::enableQueryLogging ( bool  enable)
pure virtual

Enable or disable query logging. By default logging is disabled. Query logging will record every SQL query in log streams.

Returns
this database backend (to chain configuration calls)

Implemented in ledger::core::DatabaseBackend.

◆ getConnectionPoolSize()

virtual int32_t ledger::core::api::DatabaseBackend::getConnectionPoolSize ( )
pure virtual

Get the maximum number of concurrent connection that the backend is able to open on a single database.

Returns
the size of the connection pool.

Implemented in ledger::core::ProxyBackend, and ledger::core::SQLite3Backend.

◆ getSqlite3Backend()

std::shared_ptr< api::DatabaseBackend > ledger::core::api::DatabaseBackend::getSqlite3Backend ( )
static

Create an instance of SQLite3 database.

Returns
DatabaseBackend object

◆ isLoggingEnabled()

virtual bool ledger::core::api::DatabaseBackend::isLoggingEnabled ( )
pure virtual

Return true if query logging is enabled.

Returns
trye if query logging is enabled, false otherwise.

Implemented in ledger::core::DatabaseBackend.


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