PvGetTableStat()

Developer Reference : Platform Management : Distributed Tuning Interface (DTI) Guide : Distributed Tuning Interface Reference : PvGetTableStat()

PvGetTableStat()

Returns statistical information on a given table.

Header File: ddf.h (See also Header Files)

Function First Available In Library: w3dbav90.dll (Windows), libpsqldti.so (Linux), libpsqldti.dylib (macOS) (See also Link Libraries)

Syntax

PRESULT DDFAPICALLTYPE PvGetTableStat(

BTI_WORD dbHandle,

const BTI_CHAR* tableName,

TABLESTAT* tableStat);

Arguments

In	dbHandle	Handle of an open database returned by PvOpenDatabase().
In	tableName	Table name for which you want statistical information.
Out	tableStat	TABLESTAT structure containing table statistics information.

Return Values

PCM_Success	The operation was successful.
PCM_errFailed	The operation was not successful.
PCM_errMemoryAllocation	An error occurred during memory allocation.
PCM_errInvalidDictionaryHandle	The specified dictionary handle obtained by PvOpenDatabase() is invalid.
PCM_errTableNotFound	The specified table was not found.

Remarks

You must first obtain a database handle using PvOpenDatabase().

You can retrieve more information about a specific table using PvGetTable().

If the number of records in the data file is greater than the maximum value that the TABLESTAT structure can return, then the maximum possible value is returned instead, which is 65535 as a 2-byte unsigned integer.