Collaboration diagram for Database Information Functions:

Functions
RDM_RETCODE	rdm_dbGetMemoryUsage (RDM_DB db, uint64_t systemCurr, uint64_t systemMax, uint64_t userCurr, uint64_t userMax)
	Get memory usage information for a database. More...

RDM_RETCODE	rdm_dbGetInfo (RDM_DB db, const char keyword, char 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 functions here are located in RDM DB Engine Library. Linker option:

    -lrdmrdm

Function Documentation

rdm_dbGetInfo()

RDM_RETCODE rdm_dbGetInfo	(	RDM_DB	db,
		const char *	keyword,
		char *	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.

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

Return values

sOKAY	Normal, successful return.
eINVOPTION	Invalid option identifier is specified.

See also: rdm_tfsAllocDatabase; rdm_dbOpen; rdm_dbFree

Parameters

[in]	db	A valid RDM database handle
[in]	keyword	An information keyword
[out]	infoString	information string
[in]	bytesIn	# of bytes for optString
[out]	bytesOut	result # of bytes

rdm_dbGetMemoryUsage()

RDM_RETCODE rdm_dbGetMemoryUsage	(	RDM_DB	db,
		uint64_t *	systemCurr,
		uint64_t *	systemMax,
		uint64_t *	userCurr,
		uint64_t *	userMax
	)

#include <rdmdbapi.h>

Get memory usage information for a database.

This function retrieves memory usage information for a database

The memory usage is split between system memory which is memory that is used by the engine and user data which is memory used for storing the user data (rows, keys, blobs, schema, etc.).

For a disk based database the user memory usage will always be 0 as the data is stored on disk and not in-memory.

Both disk and in-memory databases require system memory.

Locking Requirements: None

Return values

sOKAY	Normal, successful return.
eDBNOTOPEN	Database not open.

Parameters

[in]	db	A valid RDM database handle
[out]	systemCurr	The current amount of system memory in use for the database (does not include user data - rows, keys, etc.)
[out]	systemMax	The maximum total amount of system memory in use for the database (does not include user data - rows, keys, etc.)
[out]	userCurr	The current amount of memory for user data in the database
[out]	userMax	The maximum amount of memory for user data in the database

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

sOKAY Normal, successful return.

See also: rdm_tfsAllocDatabase; rdm_dbOpen; rdm_dbGetTFSType

Parameters

[in]	db	A valid RDM database handle
[out]	pTFS	A 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

sOKAY Normal, successful return.

See also: rdm_tfsAllocDatabase; rdm_dbOpen; rdm_dbGetTFS

Parameters

[in]	db	A valid RDM database handle
[out]	pTfsType	Type of TFS