getQueryBandValue(String QBandBuf, int QB_SearchType, String QBName) - Analytics Database - Teradata Vantage

SQL External Routine Programming

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2023-07-11
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
B035-1147
lifecycle
latest
Product Category
Teradata Vantage™

Search the transaction, session, and/or profile name-value pairs in the query band string pointed to by the QBandBuf input argument and retrieve the value for a specified name.

Syntax

getQueryBandValue(String QBandBuf, int QB_SearchType, String QBName)

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 getQueryBandValue() searches for name-value pairs in the transaction, session, and/or profile query band.
If the value is...
  • QueryBand.QB_FIRST, then return the value of the first name-value pair, where the name is specified by the QBName input argument. If the query band string contains name-value pairs for the transaction, session, and profile, getQueryBandValue() searches the name-value pairs in the following order:
    • Transaction query band
    • Session query band
    • Profile query band
  • QueryBand.QB_TXN, then search the transaction name-value pairs in the query band and return the value that corresponds to the name specified by the QBName input argument.
  • QueryBand.QB_SESSION, then search the session name-value pairs in the query band and return the value that corresponds to the name specified by the QBName input argument.
  • QueryBand.QB_PROFILE, then search the profile name-value pairs in the query band and return the value that corresponds to the name specified by the QBName input argument.
QBName
The name in the name-value pair to return the value for.