This is, basically, a database session.
More...
#include <DBBase.h>
|
| DBEnvironment () |
|
virtual | ~DBEnvironment () |
|
virtual ErrorCode | connect (string &pConnectionStringRef, string &pUserRef, string &pPasswordRef)=0 |
| Connects to the specified destination using the provided credentials.
|
|
virtual DBStatement * | createStatementPtr (string &pQueryRef)=0 |
| Given the specified query name, creates a DBStatement that will be linked to the session.
|
|
virtual ErrorCode | setSchema (string &pNewSchemaRef)=0 |
| When the database works with "schemas", permits to define the right one to work with.
|
|
bool | synchronizes () const |
| Indicates if the session will or not to shynchronize.
|
|
void | addSyncTo (string pSyncTo) |
| Indicates where the synchronization will go.
|
|
string & | syncToRef () |
| Returns a reference to the synchronization destination.
|
|
void | addSyncPath (string pSyncPath) |
| Indicates where the "for read" synchronization material will be stored.
|
|
string & | syncPathRef () |
| Returns a reference to the path where synchronization material will be stored.
|
|
void | addID (int pNewID) |
| Includes a numeric ID (to be used by connection pools).
|
|
int | id () |
| Returns the numeric ID previously stored, or zero if no one was defined.
|
|
string & | lastErrorRef () |
| Returns a reference to the last stored error message.
|
|
ErrorCode | lastCode () |
| Returns the last stored code.
|
|
bool | valid () |
| Permits to know if the object has a valid internal state.
|
|
string & | typeRef () |
| Permits to know the type of this particular object.
|
|
|
| HSEPObject (const char *pType) |
| Constructor, providing the base for the state controlling instance.
|
|
virtual | ~HSEPObject () |
|
void | setLastError (string &pErrorMsgRef) |
| Assigns an error message text to the last executed operation.
|
|
void | setLastError (const string &pErrorMsgRef) |
| Assigns an error message text to the last executed operation.
|
|
void | setLastError (const char *pErrorMsg) |
| Assigns an error message text to the last executed operation.
|
|
void | setValid () |
| Defines that the object has a valid state.
|
|
void | setInvalid () |
| Defines that the object has an invalid state.
|
|
void | setLastCode (const ErrorCode pErrorCode) |
| Defines the internal result code for the object.
|
|
This is, basically, a database session.
Definition at line 300 of file DBBase.h.
HSEPData::DBEnvironment::DBEnvironment |
( |
| ) |
|
|
inline |
virtual HSEPData::DBEnvironment::~DBEnvironment |
( |
| ) |
|
|
inlinevirtual |
void HSEPData::DBEnvironment::addID |
( |
int |
pNewID | ) |
|
|
inline |
void HSEPData::DBEnvironment::addSyncPath |
( |
string |
pSyncPath | ) |
|
|
inline |
void HSEPData::DBEnvironment::addSyncTo |
( |
string |
pSyncTo | ) |
|
|
inline |
virtual ErrorCode HSEPData::DBEnvironment::connect |
( |
string & |
pConnectionStringRef, |
|
|
string & |
pUserRef, |
|
|
string & |
pPasswordRef |
|
) |
| |
|
pure virtual |
Connects to the specified destination using the provided credentials.
- Todo:
- To generalize the connection credential to use other types of data (for example, security certificates).
- Parameters
-
pConnectionStringRef | The connection string |
pUserRef | The database user |
pPasswordRef | The database password |
- Returns
Implemented in HSEPDataSqLite::SqLiteEnvironment.
Referenced by HSEPData::DBDrvLib::getEnvironmentPtr().
virtual DBStatement* HSEPData::DBEnvironment::createStatementPtr |
( |
string & |
pQueryRef | ) |
|
|
pure virtual |
Given the specified query name, creates a DBStatement that will be linked to the session.
- Parameters
-
- Returns
- The statement
-
nullptr when no statement was created. Must check the instance error methods in such case.
Implemented in HSEPDataSqLite::SqLiteEnvironment.
int HSEPData::DBEnvironment::id |
( |
| ) |
|
|
inline |
Returns the numeric ID previously stored, or zero if no one was defined.
- Returns
Definition at line 398 of file DBBase.h.
virtual ErrorCode HSEPData::DBEnvironment::setSchema |
( |
string & |
pNewSchemaRef | ) |
|
|
pure virtual |
bool HSEPData::DBEnvironment::synchronizes |
( |
| ) |
const |
|
inline |
string& HSEPData::DBEnvironment::syncPathRef |
( |
| ) |
|
|
inline |
Returns a reference to the path where synchronization material will be stored.
- Returns
Definition at line 382 of file DBBase.h.
string& HSEPData::DBEnvironment::syncToRef |
( |
| ) |
|
|
inline |
int HSEPData::DBEnvironment::aID |
|
protected |
bool HSEPData::DBEnvironment::aSynchronizes |
|
protected |
string HSEPData::DBEnvironment::aSyncPath |
|
protected |
string HSEPData::DBEnvironment::aSyncTo |
|
protected |
The documentation for this class was generated from the following file: