SERIES_SPEC Syntax Elements - Teradata Vantage

Database Unbounded Array Framework Time Series Functions

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Vantage
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2024-10-04
dita:mapPath
ncd1634149624743.ditamap
dita:ditavalPath
ruu1634160136230.ditaval
dita:id
ncd1634149624743
TABLE_NAME
The source of the series data. It is a single table. The source can reference any Teradata accessible table, or a view, or a derived-table, or an ART.
ROW_AXIS
The style of indexing, which is TIMECODE or SEQUENCE, and the field which contains the indexing values. TIMECODE is an index based on date or timestamp and SEQUENCE is an index based on integer or float.
You do not have to identify the indexing data type.
SERIES_ID
The one or more field references in the database table that serve the role of the identifier. The identifier columns cannot reference a user-defined type, complex data type or LOB column. Dot notation is allowed.
ID_SEQUENCE
[Dependencies: This parameter is only used with the TD_PLOT function.] A sequence of series to plot. The ID_SEQUENCE contains a JSON object with name-value pairs. Each name corresponds to a SERIES_ID field with its associated value indicating the desired values.
PAYLOAD
The fields comprising the elements of the series, and descriptions of their contents. A series can have individual elements classified as real numbers, complex numbers, or multivariate real numbers (a vector of real numbers). In formulas in FUNC_PARAMS, the FIELDS entries represent response_variable, explanatory_variable, explanatory_variable, and so on, respectively. The FIELDS can be the following:AMPLITUDE_PHASE_RADIANS
Field Type Description
REAL Data type that represents a decimal number with a fractional component, such as 3.14 or -2.5. Real numbers can be positive or negative, and can include values such as 0 and fractions. Used for precise calculations in scientific and engineering applications.
COMPLEX Data type that represents a complex number, that consists of a real part and an imaginary part. In programming languages, a complex number is typically represented using a pair of floating-point numbers, where the first number represents the real part, and the second number represents the imaginary part.
AMPLITUDE_PHASE Data type that represents a complex number using polar coordinates, where the magnitude or amplitude, and phase are given in any unit, such as volts and degrees or meters and radians.
AMPLITUDE_PHASE_RADIANS Data type that represents a complex number using polar coordinates, where the magnitude or amplitude, and phase are given in radians. The amplitude represents the distance from the origin to the complex number, and the phase represents the angle between the positive real axis and the line connecting the origin and the complex number.
AMPLITUDE_PHASE_DEGREES Data type that represents a complex number using polar coordinates, where the magnitude or amplitude, and phase are given in degrees. The amplitude represents the distance from the origin to the complex number, and the phase represents the angle between the positive real axis and the line connecting the origin and the complex number.
MULTIVARIATE_COMPLEX Data type that represents a collection of complex numbers, where each element of the collection is itself a complex number.
MULTIVARIATE_AMPLITUDE_PHASE Data type that represents a collection of complex numbers using polar coordinates, where each element of the collection is itself a complex number specified in terms of its amplitude and phase.
MULTIVARIATE_AMPLITUDE_RADIANS Data type that represents a collection of complex numbers using polar coordinates, where each element of the collection is itself a complex number specified in terms of its amplitude and phase in radians.
MULTIVARIATE_AMPLITUDE_PHASE Data type that represents a collection of complex numbers using polar coordinates, where each element of the collection is itself a complex number specified in terms of its amplitude and phase in degrees.
LAYER
[Dependencies: This parameter is only used when the SERIES_SPEC is used to reference a particular layer in an ART.] The layer of the analytical result table (ART) that is passed to the function. An ART can have primary, secondary, tertiary, and quaternary layers. Each layer of an ART has an associated mnemonic name. The names of the ART layers output by a particular function are provided in each function description. See TD_EXTRACT_RESULTS to see which layers are available for which functions.
INTERVAL
[Optional] Indicator to divide a series into a collection of consecutive numbered intervals along its row-axis. Not all analytic framework functions support SERIES_SPEC with INTERVAL.
  • time-duration:
    • CAL_YEARS
    • CAL_MONTHS
    • CAL_DAYS
    • WEEKS
    • DAYS
    • HOURS
    • MINUTES
    • SECONDS
    • MILLISECONDS
    • MICROSECONDS
  • time-zero:
    • DATE
    • TIMESTAMP
    • TIMESTAMP WITH TIME ZONE
  • integer: A positive integer or float in a range from 1 to 32767, inclusively.
  • sequence-zero: An expression which evaluates to an INTEGER or FLOAT. Used when ROW_AXIS is SEQUENCE.