16.20 - FNC_TblOpSetExplainText - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Advanced SQL Engine
Teradata Database
Release Number
Release Date
April 2020
Content Type
Programming Reference
Publication ID
English (United States)


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


FNC_TblOpSetExplainText(int     numOfTexts,
                        char **arrayOfTexts,
                        int   *arrayOfLens);
int numOfTexts
IN parameter

The number of EXPLAIN text strings.

char **arrayOfTexts
IN parameter

An array containing the EXPLAIN text strings.

int *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.