16.20 - FNC_TblOpGetHashByDef - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)

Purpose

Retrieves the HASH BY clause information of the input stream for a table operator.

Syntax

void
FNC_TblOpGetHashByDef(int           streamno,
                      FNC_Names_t  *out_colname);
int streamno
the input stream number.
FNC_Names_t *out_colname
a pointer to the location where the column names will be stored.
For details about the FNC_Names_t structure, see Table Operator Data Structures.

Usage Notes

Before calling FNC_TblOpGetHashByDef, you must allocate memory for the out_colname buffer:

FNC_Names_t *out_colname = FNC_malloc(TblOpSIZEHASHBY(
                               FNC_TblOpCountHashByDef(streamno)) );

You must release the allocated memory when out_colname is no longer needed. If you used FNC_malloc to allocate the memory, use FNC_free to release it.