libdballe 9.6
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
dballe::DBConnectOptions Class Reference

Options controlling how to connect to a database. More...

#include <db.h>

Public Member Functions

void reset_actions ()
 Disable all the one-off actions set to perform on connection.
 

Static Public Member Functions

static std::unique_ptr< DBConnectOptionscreate (const std::string &url)
 Create a DBConnectOptions parsing the given URL.
 
static std::unique_ptr< DBConnectOptionstest_create (const char *backend=nullptr)
 Create a DBConnectOptions for running unit tests.
 

Public Attributes

std::string url
 URL to use to connect to the database.
 
bool wipe = false
 Wipe database on connection.
 

Protected Member Functions

 DBConnectOptions (const DBConnectOptions &)=default
 
 DBConnectOptions (DBConnectOptions &&)=default
 
DBConnectOptionsoperator= (const DBConnectOptions &)=default
 
DBConnectOptionsoperator= (DBConnectOptions &&)=default
 

Detailed Description

Options controlling how to connect to a database.

To allow to add members this structure without breaking the ABI, creation of new instances is restricted to DBConnectOptions::create().

Member Function Documentation

◆ reset_actions()

void dballe::DBConnectOptions::reset_actions ( )

Disable all the one-off actions set to perform on connection.

Call this after the first connection, if you need to reuse the DBConnectOptions multiple times.

◆ test_create()

static std::unique_ptr< DBConnectOptions > dballe::DBConnectOptions::test_create ( const char *  backend = nullptr)
static

Create a DBConnectOptions for running unit tests.

Optionally allows to select a backend database.

Member Data Documentation

◆ url

std::string dballe::DBConnectOptions::url

URL to use to connect to the database.

See doc/fapi_connect.md for details.


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