Products Support Documentation Download
rdmdbapi.h
Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * Raima Database Manager
3  *
4  * Copyright (c) 2014 Raima Inc., All rights reserved.
5  *
6  * Use of this software, whether in source code format, or in executable,
7  * binary object code form, is governed by the Raima LICENSE which
8  * is fully described in the LICENSE.TXT file, included within this
9  * distribution of files.
10  * ----------------------------------------------------------------------------
11  */
12 
13 /* PLEASE READ AND UNDERSTAND PRIOR TO MODIFYING THIS FILE
14  *
15  * This header file should contain the declarations for functions that are
16  * exported from the RDM runtime libarary as part of the published
17  * RDM_DB interface. These functions will be availabe for use by customers
18  * and other RDM modules, therefore they should all be declared with RDM_EXPORT
19  * and EXTERNAL_FCN.
20  *
21  * If the API takes a string as a parameter it should always use RDM_TCHAR_T
22  * and use a RDM_T_FUNC wrapper.
23  *
24  * This header file should only contain function definitions. Types,
25  * structures, enums etc. required for the RDM_DB interface (a parameter to one
26  * of the public APIs), should be declared in include/rdmtypes.h
27  *
28  */
29 
34 #if !defined(RDMDBAPI_H_INCLUDED_)
35 #define RDMDBAPI_H_INCLUDED_
36 
37 #if defined(__cplusplus) && !defined(CPP_HEADER_INCLUDED)
38 #error rdmdbapi.h is only for C applications. Do not include it directly in C++ applications. Use cpp-rdmdbapi.h instead
39 #endif
40 
41 #include "rdmtypes.h"
42 #include "rdmrowidtypes.h"
43 #include "rdmtfstypes.h"
44 
139 #if !defined(RDM_NO_UNICODE)
140 #define rdm_dbAlterCatalog RDM_T_FUNC(rdm_dbAlterCatalog)
141 #define rdm_dbEncrypt RDM_T_FUNC(rdm_dbEncrypt)
142 #define rdm_dbExport RDM_T_FUNC(rdm_dbExport)
143 #define rdm_dbGetOption RDM_T_FUNC(rdm_dbGetOption)
144 #define rdm_dbGetOptions RDM_T_FUNC(rdm_dbGetOptions)
145 #define rdm_dbGetInfo RDM_T_FUNC(rdm_dbGetInfo)
146 #define rdm_dbImport RDM_T_FUNC(rdm_dbImport)
147 #define rdm_dbOpen RDM_T_FUNC(rdm_dbOpen)
148 #define rdm_dbSetCatalog RDM_T_FUNC(rdm_dbSetCatalog)
149 #define rdm_dbSetCatalogFromFile RDM_T_FUNC(rdm_dbSetCatalogFromFile)
150 #define rdm_dbSetErrorHandler RDM_T_FUNC(rdm_dbSetErrorHandler)
151 #define rdm_dbSetOption RDM_T_FUNC(rdm_dbSetOption)
152 #define rdm_dbSetOptions RDM_T_FUNC(rdm_dbSetOptions)
153 #define rdm_dbVacuum RDM_T_FUNC(rdm_dbVacuum)
154 #endif
155 
183 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbAllocCursor (
184  RDM_DB db,
185  RDM_CURSOR *pCursor
186  );
187 
228 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbAlterCatalog (
229  RDM_DB db,
230  const RDM_TCHAR_T *ddlStmt
231  );
232 
233 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbClearCache (
234  RDM_DB db
235  );
236 
258 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbClose (
259  RDM_DB db
260  );
261 
294 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbDeleteAllRowsFromDatabase (
295  RDM_DB db
296  );
297 
298 
336 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbDeleteAllRowsFromTable (
337  RDM_DB db,
338  RDM_TABLE_ID tableId
339  );
340 
341 
342 
374 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbEncrypt (
375  RDM_DB db,
376  RDM_ENCRYPT enc,
377  const RDM_TCHAR_T *optString
378  );
379 
408 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbEnd (
409  RDM_DB db
410  );
411 
442 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbEndRollback (
443  RDM_DB db
444  );
445 
489 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbExport (
490  RDM_DB db,
491  const RDM_TCHAR_T *optString
492  );
493 
494 
514 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbVacuum (
515  RDM_DB db,
516  const RDM_TCHAR_T *optString
517  );
518 
519 
520 
542 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbFlushIdIndex (
543  RDM_DB db
544  );
545 
566 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbRebuildIdIndex (
567  RDM_DB db
568  );
569 
592 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbCreateNewPackFile (
593 RDM_DB db
594 );
595 
596 
597 
618 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbFree (
619  RDM_DB db
620  );
621 
622 
641 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetEncrypt (
642  RDM_DB db,
643  RDM_ENCRYPT *enc
644  );
645 
683 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetLockStatus (
684  RDM_DB db,
685  RDM_TABLE_ID tableId,
686  RDM_LOCK_STATUS *status
688  );
689 
690 
710 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetOption (
711  RDM_DB db,
712  const RDM_TCHAR_T *keyword,
713  RDM_TCHAR_T *optValue,
714  size_t bytesIn,
715  size_t *bytesOut
716  );
717 
740 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetOptions (
741  RDM_DB db,
742  RDM_TCHAR_T *optString,
743  size_t bytesIn,
744  size_t *bytesOut
745  );
746 
767 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetInfo(
768  RDM_DB db,
769  const RDM_TCHAR_T *keyword,
770  RDM_TCHAR_T *infoString,
771  size_t bytesIn,
772  size_t *bytesOut
773  );
774 
813 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRows (
814  RDM_DB db,
815  RDM_TABLE_ID tableId,
816  RDM_CURSOR *pCursor
817  );
818 
872 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsAtRowId (
873  RDM_DB db,
874  RDM_TABLE_ID tableId,
875  RDM_ROWID_T rowId,
876  RDM_CURSOR *pCursor
877  );
878 
879 
924 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsByKey (
925  RDM_DB db,
926  RDM_KEY_ID keyId,
927  RDM_CURSOR *pCursor
928  );
929 
993 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsByKeyAtKey (
994  RDM_DB db,
995  RDM_KEY_ID keyId,
996  const void *keyValue,
997  size_t len,
998  RDM_CURSOR *pCursor
999  );
1000 
1064 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsByKeyAtSearchKey (
1065  RDM_DB db,
1066  RDM_KEY_ID keyId,
1067  const RDM_SEARCH_KEY *keyValue,
1068  RDM_CURSOR *pCursor
1069  );
1070 
1141 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsByKeyInKeyRange (
1142  RDM_DB db,
1143  RDM_KEY_ID keyId,
1144  const void *startValue,
1145  size_t bytesInStartValue,
1146  const void *endValue,
1147  size_t bytesInEndValue,
1148  RDM_CURSOR *pCursor
1149  );
1150 
1215 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsByKeyInRangeKeyRange (
1216  RDM_DB db,
1217  RDM_KEY_ID keyId,
1218  const RDM_RANGE_KEY *startValue,
1219  const RDM_RANGE_KEY *endValue,
1220  RDM_CURSOR *pCursor
1221  );
1222 
1223 
1268 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsByKeyInRtreeKeyRange (
1269  RDM_DB db,
1270  RDM_KEY_ID keyId,
1271  const RDM_RTREE_KEY *keyValue,
1272  RDM_CURSOR *pCursor
1273  );
1274 
1275 
1341 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetRowsByKeyInSearchKeyRange (
1342  RDM_DB db,
1343  RDM_KEY_ID keyId,
1344  const RDM_SEARCH_KEY *startValue,
1345  const RDM_SEARCH_KEY *endValue,
1346  RDM_CURSOR *pCursor
1347  );
1348 
1349 
1366 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetTFS (
1367  RDM_DB db,
1368  RDM_TFS *pTFS );
1369 
1386 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetTFSType (
1387  RDM_DB db,
1388  TFS_TYPE *pTfsType
1389  );
1390 
1426 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbGetTransactionStatus (
1427  RDM_DB db,
1428  RDM_TRANS_STATUS *status
1430  );
1431 
1465 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbImport (
1466  RDM_DB db,
1467  const RDM_TCHAR_T *optString
1468  );
1469 
1520 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbInsertRow (
1521  RDM_DB db,
1522  RDM_TABLE_ID tableId,
1524  const void *colValues,
1530  size_t bytesIn,
1532  RDM_CURSOR *pCursor
1533  );
1534 
1535 
1582 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbInsertRows (
1583  RDM_DB db,
1584  RDM_TABLE_ID tableId,
1586  const void *colValues,
1592  size_t bytesIn,
1593  uint32_t num,
1595  RDM_CURSOR *pCursorStatus,
1596  RDM_CURSOR *pCursor
1597  );
1598 
1599 
1659 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbOpen (
1660  RDM_DB db,
1661  const RDM_TCHAR_T *dbNameSpec,
1662  RDM_OPEN_MODE mode
1663  );
1664 
1689 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbPersistInMemory (
1690  RDM_DB db
1691  );
1692 
1719 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbPrecommit (
1720  RDM_DB db
1721  );
1722 
1749 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbRebuildKey (
1750  RDM_DB db,
1751  RDM_KEY_ID keyId,
1752  uint32_t reportFrequency,
1754  );
1755 
1782 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbRebuildKeys (
1783  RDM_DB db,
1784  uint32_t numKeys,
1785  const RDM_KEY_ID *keyId,
1786  uint32_t reportFrequency,
1788  );
1789 
1842 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbReinsertRow (
1843  RDM_DB db,
1844  RDM_TABLE_ID tableId,
1845  RDM_ROWID_T rowId,
1846  const void *colValues,
1852  size_t bytesIn,
1854  RDM_CURSOR *pCursor
1856  );
1857 
1858 
1888 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbSetCatalog (
1889  RDM_DB db,
1890  const RDM_TCHAR_T *catalog
1891  );
1892 
1893 
1930 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbSetCatalogFromFile (
1931  RDM_DB db,
1932  const RDM_TCHAR_T *catfile
1933  );
1934 
1935 
1961 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbSetEncrypt (
1962  RDM_DB db,
1963  RDM_ENCRYPT enc
1964  );
1965 
2000 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbSetErrorHandler (
2001  RDM_DB db,
2002  RDM_ERROR_FCN errorFunction,
2004  void *userData
2006  );
2007 
2032 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbSetOption (
2033  RDM_DB db,
2034  const RDM_TCHAR_T *keyword,
2035  const RDM_TCHAR_T *strValue
2036  );
2037 
2038 
2077 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbSetOptions (
2078  RDM_DB db,
2079  const RDM_TCHAR_T *optString
2080  );
2081 
2146 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbStartRead (
2147  RDM_DB db,
2148  const RDM_TABLE_ID *tableIds,
2149  uint32_t numTableIds,
2150  RDM_TRANS *pTrans
2151  );
2152 
2189 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbStartSnapshot (
2190  RDM_DB db,
2191  const RDM_TABLE_ID *tableIds,
2192  uint32_t numTableIds,
2193  RDM_TRANS *pTrans
2194  );
2195 
2289 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbStartUpdate (
2290  RDM_DB db,
2291  const RDM_TABLE_ID *writeTableIds,
2292  uint32_t numWriteTableIds,
2293  const RDM_TABLE_ID *readTableIds,
2294  uint32_t numReadTableIds,
2295  RDM_TRANS *pTrans
2296  );
2297 
2316 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbTriggersOff (
2317  RDM_DB db
2318  );
2319 
2342 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbTriggersOn (
2343  RDM_DB db
2344  );
2345 
2346 
2372 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbTriggersStatus (
2373  RDM_DB db,
2374  RDM_TRIGGERS_STATUS *pStat
2375  );
2376 
2377 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_dbRepair (
2378  RDM_DB db,
2379  const RDM_TCHAR_T *optString
2380  );
2381 
2382 
2383 #endif /* RDMDBAPI_H_INCLUDED_ */
RDM_RETCODE rdm_dbGetOptions(RDM_DB db, RDM_TCHAR_T *optString, size_t bytesIn, size_t *bytesOut)
Get RDM database specific options.
void(* RDM_ERROR_FCN)(RDM_DB, RDM_RETCODE, const RDM_TCHAR_T *, void *)
Definition: rdmtypes.h:244
RDM_RETCODE rdm_dbInsertRows(RDM_DB db, RDM_TABLE_ID tableId, const void *colValues, size_t bytesIn, uint32_t num, RDM_CURSOR *pCursorStatus, RDM_CURSOR *pCursor)
Insert rows into a table.
RDM_RETCODE() RDM_REBUILD_INDEX_REPORT_FCN(const char *table, const char *indexes, uint64_t current, uint64_t total)
Callback function signature to report status on an ID-index rebuild.
Definition: rdmtypes.h:134
struct RDM_TRANS_S * RDM_TRANS
Definition: rdmtypes.h:242
RDM_LOCK_STATUS
Enumeration for RDM table lock status.
Definition: rdmtypes.h:114
RDM_RETCODE rdm_dbStartUpdate(RDM_DB db, const RDM_TABLE_ID *writeTableIds, uint32_t numWriteTableIds, const RDM_TABLE_ID *readTableIds, uint32_t numReadTableIds, RDM_TRANS *pTrans)
Get write locks.
struct RDM_CURSOR_S * RDM_CURSOR
Definition: rdmtypes.h:241
RDM_RETCODE rdm_dbSetErrorHandler(RDM_DB db, RDM_ERROR_FCN errorFunction, void *userData)
Replace default error reporting with a custom function.
RDM_RETCODE rdm_dbGetTFS(RDM_DB db, RDM_TFS *pTFS)
Get the RDM_TFS handle associated with a db.
Header for the native RDM Runtime types.
RDM_RETCODE rdm_dbStartSnapshot(RDM_DB db, const RDM_TABLE_ID *tableIds, uint32_t numTableIds, RDM_TRANS *pTrans)
Start a snapshot.
The RDM Partial Key data structure.
Definition: rdmtypes.h:32
RDM_RETCODE rdm_dbRebuildKeys(RDM_DB db, uint32_t numKeys, const RDM_KEY_ID *keyId, uint32_t reportFrequency, RDM_REBUILD_INDEX_REPORT_FCN *fcn)
Rebuild keys for one or more indexes.
RDM_RETCODE rdm_dbImport(RDM_DB db, const RDM_TCHAR_T *optString)
Database import API.
RDM_RETCODE rdm_dbTriggersOn(RDM_DB db)
Enable use of triggers for an open database.
RDM_RETCODE rdm_dbRebuildIdIndex(RDM_DB db)
Rebuild the database ID Index.
RDM_RETCODE rdm_dbDeleteAllRowsFromTable(RDM_DB db, RDM_TABLE_ID tableId)
Remove all rows from a table.
RDM_RETCODE rdm_dbEnd(RDM_DB db)
End a transactional operation.
RDM_RETCODE rdm_dbClose(RDM_DB db)
Close the database associated with a database handle.
RDM_RETCODE rdm_dbGetRows(RDM_DB db, RDM_TABLE_ID tableId, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with rows based on a table id.
The RDM Range Key data structure.
Definition: rdmtypes.h:77
RDM_RETCODE rdm_dbGetRowsByKey(RDM_DB db, RDM_KEY_ID keyId, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with a row set based on a key.
RDM_RETCODE rdm_dbGetLockStatus(RDM_DB db, RDM_TABLE_ID tableId, RDM_LOCK_STATUS *status)
Get the RDM_DB handle's current lock status of a table.
RDM_RETCODE rdm_dbVacuum(RDM_DB db, const RDM_TCHAR_T *optString)
Database vacuum API.
uint32_t RDM_TABLE_ID
Definition: rdmtypes.h:26
struct RDM_TFS_S * RDM_TFS
RDM TFS Handle.
Definition: rdmtfstypes.h:21
RDM_RETCODE rdm_dbTriggersStatus(RDM_DB db, RDM_TRIGGERS_STATUS *pStat)
Check the triggers use status for a database.
RDM_RETCODE rdm_dbSetCatalogFromFile(RDM_DB db, const RDM_TCHAR_T *catfile)
Associate a catalog with an allocated database.
RDM_RETCODE rdm_dbPrecommit(RDM_DB db)
Precommit a transactional operation (Two-Phase Commit phase 1)
RDM_RETCODE rdm_dbSetCatalog(RDM_DB db, const RDM_TCHAR_T *catalog)
Associate a catalog with an allocated database.
RDM_RETCODE rdm_dbGetOption(RDM_DB db, const RDM_TCHAR_T *keyword, RDM_TCHAR_T *optValue, size_t bytesIn, size_t *bytesOut)
Get a single database option into a string.
RDM_TRANS_STATUS
The RDM transaction status identifiers.
Definition: rdmtypes.h:93
RDM_RETCODE rdm_dbSetEncrypt(RDM_DB db, RDM_ENCRYPT enc)
Associate an encryption context with a database handle.
RDM_RETCODE rdm_dbAllocCursor(RDM_DB db, RDM_CURSOR *pCursor)
Allocate a cursor.
RDM_RETCODE rdm_dbSetOptions(RDM_DB db, const RDM_TCHAR_T *optString)
Set RDM options.
RDM_RETCODE rdm_dbGetRowsByKeyInRtreeKeyRange(RDM_DB db, RDM_KEY_ID keyId, const RDM_RTREE_KEY *keyValue, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with a row set based on a r-tree.
RDM_RETCODE rdm_dbFlushIdIndex(RDM_DB db)
Flush the database ID Index.
RDM_RETCODE rdm_dbRepair(RDM_DB db, const RDM_TCHAR_T *optString)
RDM_RETCODE
RDM status and error return codes.
RDM_RETCODE rdm_dbTriggersOff(RDM_DB db)
Disable use of triggers for an open database.
RDM_RETCODE rdm_dbStartRead(RDM_DB db, const RDM_TABLE_ID *tableIds, uint32_t numTableIds, RDM_TRANS *pTrans)
Get read locks.
RDM_RETCODE rdm_dbGetInfo(RDM_DB db, const RDM_TCHAR_T *keyword, RDM_TCHAR_T *infoString, size_t bytesIn, size_t *bytesOut)
Get RDM database information.
RDM_OPEN_MODE
Enumeration for open modes.
Definition: rdmtypes.h:194
RDM_RETCODE rdm_dbFree(RDM_DB db)
Free a database handle.
RDM_RETCODE rdm_dbGetRowsByKeyAtKey(RDM_DB db, RDM_KEY_ID keyId, const void *keyValue, size_t len, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with a row set that is ordered by key value and is initially positioned at th...
RDM_TRIGGERS_STATUS
Triggers status values.
Definition: rdmtypes.h:249
RDM_RETCODE rdm_dbReinsertRow(RDM_DB db, RDM_TABLE_ID tableId, RDM_ROWID_T rowId, const void *colValues, size_t bytesIn, RDM_CURSOR *pCursor)
Insert a new row into a table.
The RDM R-tree Key data structure.
Definition: rdmtypes.h:61
RDM_RETCODE rdm_dbGetTFSType(RDM_DB db, TFS_TYPE *pTfsType)
Get the type of the RDM_TFS handle associated with a database.
RDM_RETCODE rdm_dbCreateNewPackFile(RDM_DB db)
Create a new pack file.
uint32_t RDM_KEY_ID
Definition: rdmtypes.h:28
RDM_RETCODE rdm_dbEndRollback(RDM_DB db)
End and rollback a transactional operation.
RDM_RETCODE rdm_dbGetRowsAtRowId(RDM_DB db, RDM_TABLE_ID tableId, RDM_ROWID_T rowId, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with rows based on a tableId and and rowId.
RDM_RETCODE rdm_dbRebuildKey(RDM_DB db, RDM_KEY_ID keyId, uint32_t reportFrequency, RDM_REBUILD_INDEX_REPORT_FCN *fcn)
Rebuild keys for an index.
RDM_RETCODE rdm_dbPersistInMemory(RDM_DB db)
Persist in-memory tables to disk.
struct RDM_DB_S * RDM_DB
Definition: rdmtypes.h:240
TFS_TYPE
Definition: rdmtfstypes.h:24
RDM_RETCODE rdm_dbGetRowsByKeyInRangeKeyRange(RDM_DB db, RDM_KEY_ID keyId, const RDM_RANGE_KEY *startValue, const RDM_RANGE_KEY *endValue, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with rows in a specified key range.
RDM_RETCODE rdm_dbDeleteAllRowsFromDatabase(RDM_DB db)
Remove all rows from a database.
RDM_RETCODE rdm_dbClearCache(RDM_DB db)
Header for the Transactional File Server (TFS) types.
uint64_t RDM_ROWID_T
Definition: rdmrowidtypes.h:21
RDM_RETCODE rdm_dbExport(RDM_DB db, const RDM_TCHAR_T *optString)
Database export API.
#define RDM_TCHAR_T
Definition: psptypes.h:134
RDM_RETCODE rdm_dbAlterCatalog(RDM_DB db, const RDM_TCHAR_T *ddlStmt)
Process a schema DDL command.
Header for row ID types.
struct RDM_ENCRYPT_S * RDM_ENCRYPT
Definition: psptypes.h:77
RDM_RETCODE rdm_dbGetRowsByKeyInKeyRange(RDM_DB db, RDM_KEY_ID keyId, const void *startValue, size_t bytesInStartValue, const void *endValue, size_t bytesInEndValue, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with rows in a specified key range.
RDM_RETCODE rdm_dbGetRowsByKeyAtSearchKey(RDM_DB db, RDM_KEY_ID keyId, const RDM_SEARCH_KEY *keyValue, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with a row set that is ordered by key value and is initially positioned at th...
RDM_RETCODE rdm_dbGetEncrypt(RDM_DB db, RDM_ENCRYPT *enc)
Get the encryption context associated with a database handle.
RDM_RETCODE rdm_dbEncrypt(RDM_DB db, RDM_ENCRYPT enc, const RDM_TCHAR_T *optString)
Encrypt a database.
RDM_RETCODE rdm_dbSetOption(RDM_DB db, const RDM_TCHAR_T *keyword, const RDM_TCHAR_T *strValue)
Set a single RDM option from a string.
RDM_RETCODE rdm_dbGetRowsByKeyInSearchKeyRange(RDM_DB db, RDM_KEY_ID keyId, const RDM_SEARCH_KEY *startValue, const RDM_SEARCH_KEY *endValue, RDM_CURSOR *pCursor)
Associate an RDM_CURSOR with rows in a specified key range.
RDM_RETCODE rdm_dbInsertRow(RDM_DB db, RDM_TABLE_ID tableId, const void *colValues, size_t bytesIn, RDM_CURSOR *pCursor)
Insert a new row into a table at the specified rowId.
RDM_RETCODE rdm_dbOpen(RDM_DB db, const RDM_TCHAR_T *dbNameSpec, RDM_OPEN_MODE mode)
Open an existing RDM database using the specified database handle.
RDM_RETCODE rdm_dbGetTransactionStatus(RDM_DB db, RDM_TRANS_STATUS *status)
Get the transaction status for a database handle.