Syntax | Text Field Analysis | Vantage Analytics Library - Syntax - Vantage Analytics Library

Vantage Analytics Library User Guide

Deployment
VantageCloud
VantageCore
Edition
VMware
Enterprise
IntelliFlex
Lake
Product
Vantage Analytics Library
Release Number
2.2.0
Published
June 2025
ft:locale
en-US
ft:lastEdition
2025-07-02
dita:mapPath
ibw1595473364329.ditamap
dita:ditavalPath
iup1603985291876.ditaval
dita:id
zyl1473786378775
Product Category
Teradata Vantage
CALL td_analyze (
  'textfieldanalyzer',
  'required_parameter_list [ optional_parameter; [...] ]'
);
required_parameter_list
database = input_database_name;
tablename = input_table_name;
columns = { column_name [,...] | keyword };
outputdatabase = output_database;
outputtablename = output_table;
optional_parameter
{ gensqlonly = { true | false } |
  columnstoexclude = column_name [,...] |
  extendednumericanalysis = { true | false } |
  extendedunicodeanalysis = { true | false } |
  overwrite = { true | false }
}

Syntax Elements

database
The database containing the table to analyze.
tablename
The table containing the columns to analyze.
columns
The columns to analyze.
keyword Description
all All columns.
allnumeric All numeric columns.
allcharacter All character columns.
outputdatabase
The name of the database to contain the analysis results table. The function uses this name in the generated SQL to qualify the name of the analysis results table.
outputtablename
The name of the analysis results table. The function includes this name in the generated SQL. The function does not run the generated SQL.
gensqlonly
[Optional] True returns the SQL for the function as a result set but does not run it.
False runs the SQL for the function but does not return it as a result set.
Default: false
columnstoexclude
[Optional] The columns to exclude when columns specifies a keyword.
extendednumericanalysis
[Optional] Whether to extend processing to specific numeric types (integer, float, or decimal).
Default: true
extendedunicodeanalysis
[Optional] Whether to determine if a column declared to contain Unicode characters actually contains only Latin characters.
Default: false
overwrite
[Optional] Whether to drop the output tables before creating new ones.
Default: true