16.20 - tdr.SetHashByDef - 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

Sets the HASH BY specification for a specified input stream.

Syntax

tdr.SetHashByDef(  streamno,  hashbydef  )
streamno
Parameter type: integer

The input stream number.

hashbydef
Parameter type: list

A vector of column names.

Usage Notes

This function is valid only if called from the contract function.

The function must run on a PE-only node.

An error is raised in the following situations:
  • The function is called from the table operator.
  • The HASH BY metadata was already set.

Example: Set the HASH BY Specification for an Input Stream

The following statement sets the HASH BY metadata for input stream 0 with the specification that the columns in the HASH BY clause are col1 and col3.

hashbydef <- c("col1", "col3");
tdr.SetHashByDef( 0, hashbydef );