Header file of DBAL related Definitions and APIs. More...
#include "clDbalErrors.h"Go to the source code of this file.
Macros | |
| #define | CL_DB_APPEND 0x4 |
| This DB flag is used for opening a DB in APPEND mode. | |
| #define | CL_DB_CREAT 0X1 |
| This DB flag is used for creating a DB. | |
| #define | CL_DB_OPEN 0x2 |
| This DB flag is used for opening an existing DB. | |
| #define | CL_DB_SYNC 0x8 |
| One of the three DB open modes (CL_DB_CREAT, CL_DB_OPEN, CL_DB_APPEND) may be OR-ed with DB sync flag. | |
Typedefs | |
| typedef ClPtrT | ClDBEngineT |
| Engine Handle. | |
| typedef const char * | ClDBFileT |
| Type of the DB File name. | |
| typedef ClUint8T | ClDBFlagT |
| Definition of database open flag type. | |
| typedef ClPtrT | ClDBHandleT |
| Database Handle. | |
| typedef ClUint8T * | ClDBKeyHandleT |
| Type of DB Key Handle (handle to the key of the record which is to be inserted in DB or to be fetched from the DB). | |
| typedef ClDBKeyHandleT | ClDBKeyT |
| Deprecated DB Key Handle type. | |
| typedef const char * | ClDBNameT |
| Type of the name of database. | |
| typedef ClUint8T * | ClDBRecordHandleT |
| Type of DB Record Handle (handle to the record which is to be inserted in DB or to be fetched from the DB). | |
| typedef ClDBRecordHandleT | ClDBRecordT |
| Deprecated DB Record Handle type. | |
| typedef enum ClDBType | ClDBTypeT |
| Definition of Database type. | |
Enumerations | |
| enum | ClDBType { CL_DB_TYPE_HASH = 0, CL_DB_TYPE_BTREE } |
| Definition of Database type. More... | |
Functions | |
| ClRcT | clDbalClose (CL_IN ClDBHandleT dbHandle) |
| Closes a database instance. | |
| ClRcT | clDbalFirstRecordGet (CL_IN ClDBHandleT dbHandle, CL_OUT ClDBKeyHandleT *pDBKey, CL_OUT ClUint32T *pKeySize, CL_OUT ClDBRecordHandleT *pDBRec, CL_OUT ClUint32T *pRecSize) |
| Returns the first key and associated record from a database instance. | |
| ClRcT | clDbalKeyFree (CL_IN ClDBHandleT dbHandle, CL_IN ClDBKeyHandleT dbKey) |
| Frees the database key. | |
| ClRcT | clDbalNextRecordGet (CL_IN ClDBHandleT dbHandle, CL_IN ClDBKeyHandleT currentKey, CL_IN ClUint32T currentKeySize, CL_OUT ClDBKeyHandleT *pDBNextKey, CL_OUT ClUint32T *pNextKeySize, CL_OUT ClDBRecordHandleT *pDBNextRec, CL_OUT ClUint32T *pNextRecSize) |
| Returns the next key and associated record from a database instance. | |
| ClRcT | clDbalOpen (CL_IN ClDBFileT dbFile, CL_IN ClDBNameT dbName, CL_IN ClDBFlagT dbFlag, CL_IN ClUint32T maxKeySize, CL_IN ClUint32T maxRecordSize, CL_OUT ClDBHandleT *pDBHandle) |
| Opens a database instance. | |
| ClRcT | clDbalRecordDelete (CL_IN ClDBHandleT dbHandle, CL_IN ClDBKeyHandleT dbKey, CL_IN ClUint32T keySize) |
| Deletes a record from a database instance. | |
| ClRcT | clDbalRecordFree (CL_IN ClDBHandleT dbHandle, CL_IN ClDBRecordHandleT dbRec) |
| Frees the database record. | |
| ClRcT | clDbalRecordGet (CL_IN ClDBHandleT dbHandle, CL_IN ClDBKeyHandleT dbKey, CL_IN ClUint32T keySize, CL_OUT ClDBRecordHandleT *pDBRec, CL_OUT ClUint32T *pRecSize) |
| Retrieves a record from a database instance. | |
| ClRcT | clDbalRecordInsert (CL_IN ClDBHandleT dbHandle, CL_IN ClDBKeyHandleT dbKey, CL_IN ClUint32T keySize, CL_IN ClDBRecordHandleT dbRec, CL_IN ClUint32T recSize) |
| Record Operation APIs. | |
| ClRcT | clDbalRecordReplace (CL_IN ClDBHandleT dbHandle, CL_IN ClDBKeyHandleT dbKey, CL_IN ClUint32T keySize, CL_IN ClDBRecordHandleT dbRec, CL_IN ClUint32T recSize) |
| Replaces a record in a database instance. | |
| ClRcT | clDbalSync (CL_IN ClDBHandleT dbHandle, ClUint32T flags) |
| Flushes (synchronizes) the DB modifications stored in the in-memory cache to disk. | |
| ClRcT | clDbalTransactionAbort (CL_IN ClDBHandleT dbHandle) |
| Aborts a transaction on a database instance. | |
| ClRcT | clDbalTransactionBegin (CL_IN ClDBHandleT dbHandle) |
| Begins the transaction on a database instance. | |
| ClRcT | clDbalTransactionCommit (CL_IN ClDBHandleT dbHandle) |
| Commits the transaction on a database instance. | |
| ClRcT | clDbalTxnOpen (CL_IN ClDBFileT dbFile, CL_IN ClDBNameT dbName, CL_IN ClDBFlagT dbFlag, CL_IN ClUint32T maxKeySize, CL_IN ClUint32T maxRecordSize, CL_OUT ClDBHandleT *pDBHandle) |
| Transaction Related APIs. | |
Header file of DBAL related Definitions and APIs.