Administrative API Reference

sqlbftcq - Fetch Tablespace Container Query

Fetches a specified number of rows of table space container query data, each row consisting of data for a container.

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: Fetch Tablespace Container Query */
/* ... */
SQL_API_RC SQL_API_FN
  sqlbftcq (
    struct sqlca * pSqlca,
    sqluint32 MaxContainers,
    struct SQLB_TBSCONTQRY_DATA * pContainerData,
    sqluint32 * pNumContainers);
/* ... */

Generic API Syntax 



/* File: sqlutil.h */
/* API: Fetch Tablespace Container Query */
/* ... */
SQL_API_RC SQL_API_FN
  sqlgftcq (
    struct sqlca * pSqlca,
    sqluint32 MaxContainers,
    struct SQLB_TBSCONTQRY_DATA * pContainerData,
    sqluint32 * pNumContainers);
/* ... */

API Parameters

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

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

pContainerData
Output. Pointer to the output area, a structure for query data. For more information about this structure, see SQLB-TBSCONTQRY-DATA. The caller of this API must allocate space for MaxContainers of these structures, and set pContainerData to point to this space. The API will use this space to return the table space container data.

pNumContainers
Output. Number of rows of output returned.

Sample Programs

C
\sqllib\samples\c\tabscont.sqc

COBOL
\sqllib\samples\cobol\tabscont.sqb

Usage Notes

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

For more information, see sqlbotcq - Open Tablespace Container Query.

See Also

sqlbctcq - Close Tablespace Container Query

sqlbotcq - Open Tablespace Container Query

sqlbstsc - Set Tablespace Containers

sqlbtcq - Tablespace Container Query.

[ Top of Page | Previous Page | Next Page ]