Parameter Input | Vantage Analytics Library - Parameter Input - Vantage Analytics Library

Vantage Analytics Library User Guide

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Vantage Analytics Library
Release Number
2.2.0
Published
March 2023
Language
English (United States)
Last Update
2024-01-02
dita:mapPath
ibw1595473364329.ditamap
dita:ditavalPath
iup1603985291876.ditaval
dita:id
zyl1473786378775
Product Category
Teradata Vantage

The Vantage Analytics Library function name and its parameter list are string parameters of the td_analyze stored procedure. As such, they must be enclosed in single quotation marks.

Each function parameter must be specified as a name-value pair followed by a semicolon.

A td_analyze call can be a single line. Example:

CALL td_analyze('values','database=val_source;tablename=customer;columns=age;');

Alternatively, a td_analyze call can contain carriage return, line feed, or space characters to enhance readability. Example:

CALL td_analyze (
  'values',
  'database = val_source;
   tablename = customer;
   columns = age;'
);
Leading and trailing space characters are trimmed from parameter names but not from parameter values.

Empty strings are not supported in the places where a string is the value of a parameter. This includes single or double quotes with 0 or more spaces.

String Literal Parameter Values

Because the function name and parameter list must be enclosed in single quotation marks, the single quotation marks around string literal parameter values must be "escaped" (enclosed in doubled single quotation marks). For example:

where = gender = ''F''

Boolean Parameters

You must specify the value true or false for a Boolean parameter. Example:

gensqlonly = true
gensqlonly = false

Specifying a Boolean parameter with no value is an error.

Parameters that Specify Input Columns

Most Vantage Analytics Library functions have a parameter for specifying input columns.

You can always specify input columns by name. For example, the following parameter specifies input columns c1, c2, and c3:

columns = c1, c2, c3
There are functions where you can also specify input columns with the following keywords:
Keyword Description
all All columns.
allnumeric All numeric columns.
allnumericanddate All numeric and date columns.
allcharacter All character columns.

With the preceding keywords, you can also use the parameter columnstoexclude to specify columns to exclude from analysis. Any dependent variable and group by columns are excluded automatically—you need not specify them.

Order of Required Parameters

You need not specify the parameters in the required_parameter_list in the order shown.

Unicode

To use Teradata object names that are not part of the ASCII (default) character set, you must add the charset parameter to your parameter input.
charset=<charset name>

Only UTF8 and ASCII are supported.