Products Support Documentation Download
Database Information Functions
Collaboration diagram for Database Information Functions:

Functions

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. More...
 
RDM_RETCODE rdm_dbGetTFS (RDM_DB db, RDM_TFS *pTFS)
 Get the RDM_TFS handle associated with a db. More...
 
RDM_RETCODE rdm_dbGetTFSType (RDM_DB db, TFS_TYPE *pTfsType)
 Get the type of the RDM_TFS handle associated with a database. More...
 

Detailed Description

API for retrieving the TFS information for a database. All the fuctions here are located in RDM DB Engine Library. Linker option:

    -lrdmrdm

Function Documentation

◆ rdm_dbGetInfo()

RDM_RETCODE rdm_dbGetInfo ( RDM_DB  db,
const RDM_TCHAR_T keyword,
RDM_TCHAR_T infoString,
size_t  bytesIn,
size_t *  bytesOut 
)

#include <rdmdbapi.h>

Get RDM database information.

The function returns a semicolon-delimited list of information keywords and returns information associated with the keyword.

key should be a list of info values. If key is NULL, the function returns the pairs for all available options. If key is an empty string, the function returns an empty string.

Options are defined using keys or properties. Every key has a name and a value, delimited by an equals sign (=). The key name appears to the left of the equals sign. Key names are not case-sensitive. Unless otherwise noted, values are not case-sensitive.

Key Value Description
timeout Specify default lock timeout in seconds.
time_zone Specify current time zone.
storage Specify database storage mode.
cache_size Specify cache size.
item_format Specify row storage form.
locale Specify database locale.
error_format Specify error message format.
durability Specify database transaction safety level.
pack_file_size Specify pack file maximum size.
db_size Specify the maximum database size allocation.
vacuum_percentage Specify the vacuum trigger level for pack files.
vacuum_write_chunk_sizeSpecify the vacuum scan size for pack files.
vacuum_read_chunk_size Specify the vacuum write size for pack files.
idindex_flush_threshold_on_close Specify the threshold for flushing the ID-index when the last database user closes the database.
idindex_flush_threshold Specify the threshold for flushing the ID-index.
idindex_cache_size Specify the size of the ID-index cache in byte.

Return values
sOKAYNormal, successful return.
eINVOPTIONInvalid option is specified.
See also
rdm_tfsAllocDatabase
rdm_dbOpen
rdm_dbFree
Parameters
[in]dbA valid RDM database handle
[in]keywordAn information keyword
[out]infoStringinformation string
[in]bytesIn# of bytes for optString
[out]bytesOutresult # of bytes

◆ rdm_dbGetTFS()

RDM_RETCODE rdm_dbGetTFS ( RDM_DB  db,
RDM_TFS pTFS 
)

#include <rdmdbapi.h>

Get the RDM_TFS handle associated with a db.

This function assigns the RDM_TFS handle associated with an RDM_DB to pTFS.

Locking Requirements
None.
Return values
sOKAYNormal, successful return.
See also
rdm_tfsAllocDatabase
rdm_dbOpen
rdm_dbGetTFSType
Parameters
[in]dbA valid RDM database handle
[out]pTFSA pointer to an RDM_TFS that will be assigned the TFS handle associated with db

◆ rdm_dbGetTFSType()

RDM_RETCODE rdm_dbGetTFSType ( RDM_DB  db,
TFS_TYPE pTfsType 
)

#include <rdmdbapi.h>

Get the type of the RDM_TFS handle associated with a database.

This function assigns the type of the RDM_TFS handle associated with an RDM_DB to pTfsType

Locking Requirements
None.
Return values
sOKAYNormal, successful return.
See also
rdm_tfsAllocDatabase
rdm_dbOpen
rdm_dbGetTFS
Parameters
[in]dbA valid RDM database handle
[out]pTfsTypeType of TFS