Administrative API Reference

sqlbgtss - Get Tablespace Statistics

Provides information on the space utilization of a table space.

Scope

In a partitioned database server environment, only the table spaces on the current node are listed.

Authorization

One of the following:

Required Connection

Database

Version

sqlutil.h

C API Syntax 



/* File: sqlutil.h */
/* API: Get Tablespace Statistics */
/* ... */
SQL_API_RC SQL_API_FN
  sqlbgtss (
    struct sqlca * pSqlca,
    sqluint32 TablespaceId,
    struct SQLB_TBS_STATS * pTablespaceStats);
/* ... */

Generic API Syntax 



/* File: sqlutil.h */
/* API: Get Tablespace Statistics */
/* ... */
SQL_API_RC SQL_API_FN
  sqlggtss (
    struct sqlca * pSqlca,
    sqluint32 TablespaceId,
    struct SQLB_TBS_STATS * pTablespaceStats);
/* ... */

API Parameters

pSqlca
Output. A pointer to the sqlca structure. For more information about this structure, see SQLCA.

TablespaceId
Input. ID of the single table space to be queried.

pTablespaceStats
Output. A pointer to a user-allocated SQLB_TBS_STATS structure. The information about the table space is returned in this structure. For more information about this structure, see SQLB-TBS-STATS.

Sample Programs

C
\sqllib\samples\c\tabspace.sqc

COBOL
\sqllib\samples\cobol\tabspace.sqb

Usage Notes

See SQLB-TBS-STATS for information about the fields returned and their meaning.

See Also

sqlbctsq - Close Tablespace Query

sqlbftpq - Fetch Tablespace Query

sqlbotsq - Open Tablespace Query

sqlbstpq - Single Tablespace Query

sqlbmtsq - Tablespace Query.

[ Top of Page | Previous Page | Next Page ]