getQueryBandPairs(String QBandBuf, int QB_SearchType) - Advanced SQL Engine - Teradata Database

SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Published
July 2021
Language
English (United States)
Last Update
2021-07-27
dita:mapPath
rin1593638965306.ditamap
dita:ditavalPath
rin1593638965306.ditaval
dita:id
B035-1147
lifecycle
previous
Product Category
Teradata Vantageā„¢

Returns transaction, session, or profile name-value pairs from the query band string QBandBuf.

The encoding of the byte array is a name followed by a value, then a name followed by a value, and so forth, where, if the server character set is LATIN, a '\0' delimits each item and if the server character set is UNICODE, two '\0' delimit each item.

Syntax

getQueryBandPairs(String QBandBuf, int QB_SearchType)

Syntax Elements

QBandBuf
A query band string, where the query band can be:
  • Returned by QueryBand.getQueryBand()
  • Retrieved from the DBC.DBQLogTbl.QueryBand column
  • Specified by the caller
QB_SearchType
Specifies whether getQueryBandPairs() searches for name-value pairs in the transaction, session, and/or profile query band.
If the value is...
  • QueryBand.QB_FIRST, then return the first unique name-value pair for each name found in the transaction, session, and profile query bands. If the transaction, session, and profile query bands contain the same name, getQueryBandPairs() returns the first name-value pair found in the query band in the following order:
    • Transaction query band
    • Session query band
    • Profile query band
  • QueryBand.QB_TXN, then return name-value pairs in the transaction query band.
  • QueryBand.QB_SESSION, then return name-value pairs in the session query band.
  • QueryBand.QB_PROFILE, then return name-value pairs in the profile query band.