FNC_TblOpSetExplainText Function | C Library Functions | Teradata Vantage - 17.10 - FNC_TblOpSetExplainText - Advanced SQL Engine - Teradata Database

Teradata Vantageā„¢ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1147-171K
Language
English (United States)

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.