16.20 - GetQueryBandPairs - Teradata Vantage NewSQL Engine

Teradata Vantage™ Application Programming Reference

prodname
Teradata Database
Teradata Vantage NewSQL Engine
vrm_release
16.20
created_date
March 2019
category
Programming Reference
featnum
B035-1090-162K

Purpose

Returns the name and value pairs in the query band.

Definition

REPLACE FUNCTION SYSLIB.GetQueryBandPairs(SearchType SMALLINT)
  RETURNS TABLE
   (QBName  VARCHAR(129) CHARACTER SET UNICODE,
    QBValue VARCHAR(257) CHARACTER SET UNICODE
   )
            .
            .
            .
;
REPLACE FUNCTION SYSLIB.GetQueryBandPairs
   (QueryBandIn  TD_ANYTYPE,
    SearchType   SMALLINT
    )
  RETURNS TABLE
   (QBName  VARCHAR(129) CHARACTER SET UNICODE,
    QBValue VARCHAR(257) CHARACTER SET UNICODE
    )
            .
            .
            .
;

Input Parameters

Input Parameter Description
QueryBandIn Query band string.
SearchType 0 = Return the name-value pairs in both transaction and session query bands are returned. If the same name occurs in both the transaction and the session query bands, the value for the transaction query band is returned.

1 = Return only the name-value pairs in the transaction query band.

2 = Return only the name-value pairs in the session query band.

3 - Return only the name-value pairs in the profile query band.

Result Rows

Column Name Description
QBName Name of the query band.
QBValue Value of the query band.

Usage Notes

GetQueryBandPairs are two overloaded table functions. One requires the query band string to be passed in; the other uses internal calls to retrieve the query band.

Both functions are created in the SYSLIB database by the DEM DIP script. EXECUTE privileges are granted to PUBLIC by default. For more information, see Requirements for Using the API.

Example: Using GetQueryBandPairs

The following example shows how to call the GetQueryBandPairs function.

SELECT * FROM TABLE(GetQueryBandPairs(0)) AS t1;
 *** Query completed. 3 rows found. 2 columns returned.
 *** Total elapsed time was 1 second.
QBName    QBValue
--------- ---------------
ORG       FINANCE
JOB       ENDOFMONTH
JOBID      193858

Example: Using GetQueryBandPairs with MonitorQueryBand as Input

The following example shows how to call the GetQueryBandPairs function using the MonitorQueryBand function as input.

SELECT * FROM TABLE(GetQueryBandPairs(MonitorQueryBand(1, 103, 16383), 0)) AS t1;
 *** Query completed. 3 rows found. 2 columns returned.
 *** Total elapsed time was 1 second.
QBName     QBValue
---------- ---------------
ORG       FINANCE
JOB       ENDOFMONTH
JOBID      193858