Arguments - Aster Analytics

Teradata Aster Analytics Foundation User Guide

Product
Aster Analytics
Release Number
6.21
Published
November 2016
Language
English (United States)
Last Update
2018-04-14
dita:mapPath
kiu1466024880662.ditamap
dita:ditavalPath
AA-notempfilter_pdf_output.ditaval
dita:id
B700-1021
lifecycle
previous
Product Category
Software
Argument Category Description
TimeColumn Required Specifies the names of the input_table columns that contain the start and end times of the time interval to be burst.
TimeInterval Optional Specifies the length of each burst time interval. This value must be either INTEGER or DOUBLE PRECISION.
Specify exactly one of time_table, TimeInterval, or NumPoints.
ValueColumns Required Specifies the names of input_table columns to copy to the output table.
TimeDataType Optional Specifies the data type of the output columns that correspond to the input table columns that TimeColumn specifies (start_time_column and end_time_column).

If you omit this argument, then the function infers the data type of start_time_column and end_time_column from the input table and uses the inferred data type for the corresponding output table columns.

If you specify this argument, then the function can transform the input data to the specified output data type only if both the input column data type and the specified output column data type are in this list:
  • INTEGER
  • BIGINT
  • SMALLINT
  • DOUBLE PRECISION
  • DECIMAL(n,n)
  • DECIMAL
  • NUMERIC
  • NUMERIC(n,n)
ValueDataType Optional Specifies the data types of the output columns that correspond to the input table columns that ValueColumns specifies.

If you omit this argument, then the function infers the data type of each value_column from the input table and uses the inferred data type for the corresponding output table column.

If you specify ValueDataType, then it must be the same size as ValueColumns. That is, if ValueColumns specifies n columns, then ValueDataType must specify n data types. For i in [1, n], value_column_i has value_type_i. However, value_type_i can be empty; for example:

ValueColumns (c1, c2, c3)

ValueDataType (INTEGER, ,VARCHAR)

If you specify this argument, then the function can transform the input data to the specified output data type only if both the input column data type and the specified output column data type are in this list:
  • INTEGER
  • BIGINT
  • SMALLINT
  • DOUBLE PRECISION
  • DECIMAL(n,n)
  • DECIMAL
  • NUMERIC
  • NUMERIC(n,n)
StartTime Optional Specifies the start time for the time interval to be burst. The default value is the value in start_time_column.
EndTime Optional Specifies the end time for the time interval to be burst. The default value is the value in end_time_column.
NumPoints Optional Specifies the number of data points in each burst time interval. This value must be an INTEGER.
Specify exactly one of time_table, TimeInterval, or NumPoints.
ValuesBeforeFirst Optional Specifies the values to use if start_time is before start_time_column. Each of these values must have the same data type as its corresponding value_column. Values of data type VARCHAR are case-insensitive.

If you specify ValuesBeforeFirst, then it must be the same size as ValueColumns. That is, if ValueColumns specifies n columns, then ValuesBeforeFirst must specify n values. For i in [1, n], value_column_i has the value before_first_value_i. However, before_first_value_i can be empty; for example:

ValueColumns (c1, c2, c3)

ValuesBeforeFirst (1, ,'abc')

If before_first_value_i is empty, then value_column_i has the value NULL. If you do not specify ValuesBeforeFirst, then value_column_i has the value NULL for i in [1, n].

ValuesAfterLast Optional Specifies the values to use if end_time is after end_time_column. Each of these values must have the same data type as its corresponding value_column. Values of data type VARCHAR are case-insensitive.

If you specify ValuesAfterLast, then it must be the same size as ValueColumns. That is, if ValueColumns specifies n columns, then ValuesAfterLast must specify n values. For i in [1, n], value_column_i has the value after_last_value_i. However, after_last_value_i can be empty; for example:

ValueColumns (c1, c2, c3)

ValuesAfterLast (1, ,'abc')

If after_last_value_i is empty, then value_column_i has the value NULL. If you do not specify Values_After_Last, then value_column_i has the value NULL for i in [1, n].

Accumulate Optional Specifies the names of input_table columns (other than those specified by TimeColumn and ValueColumns) to copy to the output table. By default, the function copies to the output table only the columns specified by TimeColumn and ValueColumns.