Syntax | Values Analysis | Vantage Analytics Library - Syntax - Vantage Analytics Library

CALL td_analyze (
  'values',
  'required_parameter_list [ optional_parameter; [...] ]'
);

required_parameter_list

database = input_database_name;
tablename = input_table_name;
columns = { column_name [,...] | keyword };

optional_parameter

{ columnstoexclude = column_name [,...] |
  gensqlonly = { true | false } |
  groupby = column_name [,...] |
  outputdatabase = output_database_name |
  outputtablename = output_table_name |
  overwrite = { true | false } |
  uniques = { true | false } |
  where = expression
}

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.
allnumericanddate	All numeric and date columns.

If you specify multiple columns:

• The function builds a VOLATILE table, processing all columns in a single CREATE VOLATILE TABLE AS SELECT statement and reformatting data with individual INSERT/SELECT statements into the final output dataset.
• tablename cannot specify a view.

columnstoexclude

[Optional] The columns to exclude when columns specifies a keyword.

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

groupby

[Optional] The input table columns for which to separately analyze each value or combination of values.

Default behavior: Input is not grouped.

outputdatabase

[Optional] The name of the database to contain the analysis results table.

outputtablename

[Optional] The name of the table to store the analysis results.

Default behavior: Function returns results as a result set but does not create an output table.

overwrite

[Optional] Whether to drop the output tables before creating new ones.

Default: true

uniques

[Optional] Whether to count unique values for each selected column.

Default: false

where

[Optional] The expression in the SQL WHERE clause to include in the generated SQL to filter rows selected for analysis.

Examples:

• where = cust_id > 0 includes this WHERE clause in the generated SQL:

  WHERE cust_id > 0

• where = gender = ''F'' includes this WHERE clause in the generated SQL:

  WHERE gender='F'