sqlbftcq API - Fetch the query data for rows in a table space container

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 environment, only the table spaces on the current database partition are listed.

Authorization

One of the following authorities:
  • SYSADM
  • SYSCTRL
  • SYSMAINT
  • SYSMON
  • DBADM

Required connection

Database

API include file

sqlutil.h

API and data structure syntax

SQL_API_RC SQL_API_FN
  sqlbftcq (
   struct sqlca * pSqlca,
   sqluint32 MaxContainers,
   struct SQLB_TBSCONTQRY_DATA * pContainerData,
   sqluint32 * pNumContainers);

SQL_API_RC SQL_API_FN
  sqlgftcq (
   struct sqlca * pSqlca,
   sqluint32 MaxContainers,
   struct SQLB_TBSCONTQRY_DATA * pContainerData,
   sqluint32 * pNumContainers);

sqlbftcq API parameters

pSqlca
Output. A pointer to the sqlca structure.
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.

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.