Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
dbiplus::Database Class Referenceabstract

#include <dataset.h>

Inheritance diagram for dbiplus::Database:
dbiplus::MysqlDatabase dbiplus::SqliteDatabase

Public Member Functions

 Database ()
 
virtual ~Database ()
 
virtual DatasetCreateDataset ()=0
 
virtual void setHostName (const char *newHost)
 
const char * getHostName () const
 
void setPort (const char *newPort)
 
const char * getPort () const
 
virtual void setDatabase (const char *newDb)
 
const char * getDatabase () const
 
void setLogin (const char *newLogin)
 
const char * getLogin () const
 
void setPasswd (const char *newPasswd)
 
const char * getPasswd () const
 
virtual bool isActive () const
 
void setSequenceTable (const char *new_seq_table)
 
const char * getSequenceTable () const
 
const char * getDefaultCharset () const
 
virtual void setConfig (const char *newKey, const char *newCert, const char *newCA, const char *newCApath, const char *newCiphers, unsigned int newConnectTimeout, bool newCompression)
 
virtual int init ()
 
virtual int status ()
 
virtual int setErr (int err_code, const char *qry)=0
 
virtual const char * getErrorMsg ()
 
virtual int connect (bool create)
 
virtual int connectFull (const char *newDb, const char *newHost=nullptr, const char *newLogin=nullptr, const char *newPasswd=nullptr, const char *newPort=nullptr, const char *newKey=nullptr, const char *newCert=nullptr, const char *newCA=nullptr, const char *newCApath=nullptr, const char *newCiphers=nullptr, bool newCompression=false)
 
virtual void disconnect ()
 
virtual int postconnect ()
 
virtual int reset ()
 
virtual int create ()
 
virtual int drop ()
 
virtual long nextid (const char *seq_name)=0
 
virtual int copy (const char *new_name)
 
virtual int drop_analytics ()
 
virtual bool exists ()
 
virtual void start_transaction ()
 
virtual void commit_transaction ()
 
virtual void rollback_transaction ()
 
virtual std::string prepare (const char *format,...)
 Prepare a SQL statement for execution or querying using C printf nomenclature.
 
virtual std::string vprepare (const char *format, va_list args)=0
 Prepare a SQL statement for execution or querying using C printf nomenclature.
 
virtual bool in_transaction ()
 

Protected Attributes

bool active {false}
 
bool compression {false}
 
std::string error
 
std::string host
 
std::string port
 
std::string db
 
std::string login
 
std::string passwd
 
std::string sequence_table {"db_sequence"}
 
std::string default_charset
 
std::string key
 
std::string cert
 
std::string ca
 
std::string capath
 
std::string ciphers
 
unsigned int connect_timeout
 

Constructor & Destructor Documentation

◆ Database()

dbiplus::Database::Database ( )
default

◆ ~Database()

dbiplus::Database::~Database ( )
virtual

Member Function Documentation

◆ commit_transaction()

virtual void dbiplus::Database::commit_transaction ( )
inlinevirtual

◆ connect()

virtual int dbiplus::Database::connect ( bool  create)
inlinevirtual

◆ connectFull()

int dbiplus::Database::connectFull ( const char *  newDb,
const char *  newHost = nullptr,
const char *  newLogin = nullptr,
const char *  newPasswd = nullptr,
const char *  newPort = nullptr,
const char *  newKey = nullptr,
const char *  newCert = nullptr,
const char *  newCA = nullptr,
const char *  newCApath = nullptr,
const char *  newCiphers = nullptr,
bool  newCompression = false 
)
virtual

◆ copy()

virtual int dbiplus::Database::copy ( const char *  new_name)
inlinevirtual

◆ create()

virtual int dbiplus::Database::create ( )
inlinevirtual

◆ CreateDataset()

virtual Dataset * dbiplus::Database::CreateDataset ( )
pure virtual

◆ disconnect()

virtual void dbiplus::Database::disconnect ( )
inlinevirtual

◆ drop()

virtual int dbiplus::Database::drop ( )
inlinevirtual

◆ drop_analytics()

virtual int dbiplus::Database::drop_analytics ( )
inlinevirtual

◆ exists()

virtual bool dbiplus::Database::exists ( )
inlinevirtual

◆ getDatabase()

const char * dbiplus::Database::getDatabase ( ) const
inline

◆ getDefaultCharset()

const char * dbiplus::Database::getDefaultCharset ( ) const
inline

◆ getErrorMsg()

virtual const char * dbiplus::Database::getErrorMsg ( )
inlinevirtual

◆ getHostName()

const char * dbiplus::Database::getHostName ( ) const
inline

◆ getLogin()

const char * dbiplus::Database::getLogin ( ) const
inline

◆ getPasswd()

const char * dbiplus::Database::getPasswd ( ) const
inline

◆ getPort()

const char * dbiplus::Database::getPort ( ) const
inline

◆ getSequenceTable()

const char * dbiplus::Database::getSequenceTable ( ) const
inline

◆ in_transaction()

virtual bool dbiplus::Database::in_transaction ( )
inlinevirtual

◆ init()

virtual int dbiplus::Database::init ( )
inlinevirtual

◆ isActive()

virtual bool dbiplus::Database::isActive ( ) const
inlinevirtual

◆ nextid()

virtual long dbiplus::Database::nextid ( const char *  seq_name)
pure virtual

◆ postconnect()

virtual int dbiplus::Database::postconnect ( )
inlinevirtual

Reimplemented in dbiplus::SqliteDatabase.

◆ prepare()

std::string dbiplus::Database::prepare ( const char *  format,
  ... 
)
virtual

Prepare a SQL statement for execution or querying using C printf nomenclature.

Parameters
format- C printf compliant format string
...- optional comma separated list of variables for substitution in format string placeholders.
Returns
escaped and formatted string.

◆ reset()

virtual int dbiplus::Database::reset ( )
inlinevirtual

◆ rollback_transaction()

virtual void dbiplus::Database::rollback_transaction ( )
inlinevirtual

◆ setConfig()

virtual void dbiplus::Database::setConfig ( const char *  newKey,
const char *  newCert,
const char *  newCA,
const char *  newCApath,
const char *  newCiphers,
unsigned int  newConnectTimeout,
bool  newCompression 
)
inlinevirtual

◆ setDatabase()

virtual void dbiplus::Database::setDatabase ( const char *  newDb)
inlinevirtual

Reimplemented in dbiplus::SqliteDatabase.

◆ setErr()

virtual int dbiplus::Database::setErr ( int  err_code,
const char *  qry 
)
pure virtual

◆ setHostName()

virtual void dbiplus::Database::setHostName ( const char *  newHost)
inlinevirtual

Reimplemented in dbiplus::SqliteDatabase.

◆ setLogin()

void dbiplus::Database::setLogin ( const char *  newLogin)
inline

◆ setPasswd()

void dbiplus::Database::setPasswd ( const char *  newPasswd)
inline

◆ setPort()

void dbiplus::Database::setPort ( const char *  newPort)
inline

◆ setSequenceTable()

void dbiplus::Database::setSequenceTable ( const char *  new_seq_table)
inline

◆ start_transaction()

virtual void dbiplus::Database::start_transaction ( )
inlinevirtual

◆ status()

virtual int dbiplus::Database::status ( )
inlinevirtual

◆ vprepare()

virtual std::string dbiplus::Database::vprepare ( const char *  format,
va_list  args 
)
pure virtual

Prepare a SQL statement for execution or querying using C printf nomenclature.

Parameters
format- C printf compliant format string
args- va_list of variables for substitution in format string placeholders.
Returns
escaped and formatted string.

Implemented in dbiplus::MysqlDatabase, and dbiplus::SqliteDatabase.

Member Data Documentation

◆ active

bool dbiplus::Database::active {false}
protected

◆ ca

std::string dbiplus::Database::ca
protected

◆ capath

std::string dbiplus::Database::capath
protected

◆ cert

std::string dbiplus::Database::cert
protected

◆ ciphers

std::string dbiplus::Database::ciphers
protected

◆ compression

bool dbiplus::Database::compression {false}
protected

◆ connect_timeout

unsigned int dbiplus::Database::connect_timeout
protected

◆ db

std::string dbiplus::Database::db
protected

◆ default_charset

std::string dbiplus::Database::default_charset
protected

◆ error

std::string dbiplus::Database::error
protected

◆ host

std::string dbiplus::Database::host
protected

◆ key

std::string dbiplus::Database::key
protected

◆ login

std::string dbiplus::Database::login
protected

◆ passwd

std::string dbiplus::Database::passwd
protected

◆ port

std::string dbiplus::Database::port
protected

◆ sequence_table

std::string dbiplus::Database::sequence_table {"db_sequence"}
protected

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