FNC_TblOpSetExplainText Function | C Library Functions | Teradata Vantage - FNC_TblOpSetExplainText - 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ā„¢

Sets the EXPLAIN text when the table operator has the hexplain custom clause set.

Syntax

void
FNC_TblOpSetExplainText(int     numOfTexts,
                        char **arrayOfTexts,
                        int   *arrayOfLens);

Syntax Elements

numOfTexts
IN parameter

The number of EXPLAIN text strings.

arrayOfTexts
IN parameter

An array containing the EXPLAIN text strings.

arrayOfLens
IN parameter

An array containing the lengths of each EXPLAIN text string.

Usage Notes

Hexplain has the following values for the type of EXPLAIN to be completed:
  • 1 = simple
  • 2 = verbose
  • 3 = DBQL

This routine accepts multiple self-contained EXPLAIN text strings as input in order to handle a multi-row EXPLAIN plan from a foreign server. The routine provides the EXPLAIN plan to the parser which will display the multiple lines of the EXPLAIN plan.

This routine is callable on a PE vproc only by a table operator.