Syntax | Overlap Analysis Function | Vantage Analytics Library - Syntax - Vantage Analytics Library

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

required_parameter_list

database = input_database_name [,...];
tablename = input_table_name [,...];
columns = input_table_key [,...];

You must type the colored or bold braces.

optional_parameter

{ gensqlonly = { true | false } |
  outputdatabase = output_database |
  outputtablename = output_table |
  overwrite = { true | false }
}

input_table_key

{ column_name [,...] }

You must type the colored or bold braces.

Syntax Elements

database

The database or databases containing the table or tables to analyze.

The number of databases specified by database and the number of tables specified by tablename must be the same. They are matched by position, and you can repeat the database names. For example, database=d1,d1,d2 and tablename=t1,t2,t3 specifies that the tables to analyze are d1.t1, d1.t2, and d2.t3 Tables t1 and t2 are in database d1.

tablename

The table or tables containing the columns to analyze.

No table can be a view.

columns

The key column or columns of the input table or tables.

Specify an input_table_key for each input_table_name. In each input_table_key, specify the columns that comprise the key for the corresponding input table. Each input_table_key must have the same number of columns.

For example, for tablename=customer,customer_analysis:

• If the key of each input table is the column cust_id: columns={cust_id},{cust_id}
• If the key of each input table is the pair of columns cust_id and tran_id: columns={cust_id,tran_id},{cust_id,tran_id}

If the key columns have different names in different tables, the column names in the input_table_key may differ.

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

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