Administrative API Reference

sqlbftpq - Fetch Tablespace Query

Fetches a specified number of rows of table space query data, each row consisting of data for 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:

• sysadm
• sysctrl
• sysmaint
• dbadm
• load

Required Connection

Database

Version

sqlutil.h

C API Syntax

/* File: sqlutil.h */ /* API: Fetch Tablespace Query */ /* ... */ SQL_API_RC SQL_API_FN sqlbftpq ( struct sqlca * pSqlca, sqluint32 MaxTablespaces, struct SQLB_TBSPQRY_DATA * pTablespaceData, sqluint32 * pNumTablespaces); /* ... */

Generic API Syntax

/* File: sqlutil.h */ /* API: Fetch Tablespace Query */ /* ... */ SQL_API_RC SQL_API_FN sqlgftpq ( struct sqlca * pSqlca, sqluint32 MaxTablespaces, struct SQLB_TBSPQRY_DATA * pTablespaceData, sqluint32 * pNumTablespaces); /* ... */

API Parameters

pSqlca

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

MaxTablespaces

Input. The maximum number of rows of data that the user allocated output area (pointed to by pTablespaceData) can hold.

pTablespaceData

Input and output. Pointer to the output area, a structure for query data. For more information about this structure, see SQLB-TBSPQRY-DATA. The caller of this API must:

• Allocate space for MaxTablespaces of these structures
• Initialize the structures
• Set TBSPQVER in the first structure to SQLB_TBSPQRY_DATA_ID
• Set pTablespaceData to point to this space. The API will use this space to return the table space data.

pNumTablespaces

Output. Number of rows of output returned.

Sample Programs

C

\sqllib\samples\c\tabspace.sqc

COBOL

\sqllib\samples\cobol\tabspace.sqb

Usage Notes

The user is responsible for allocating and freeing the memory pointed to by the pTablespaceData parameter. This API can only be used after a successful sqlbotsq call. It can be invoked repeatedly to fetch the list generated by sqlbotsq.

For more information, see sqlbotsq - Open Tablespace Query.

See Also

sqlbctsq - Close Tablespace Query

sqlbgtss - Get Tablespace Statistics

sqlbotsq - Open Tablespace Query

sqlbstpq - Single Tablespace Query

sqlbmtsq - Tablespace Query.