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
TextColumn Required Specifies the name of the input table column that contains the XML documents. The function skips malformed XML documents.
DocIDColumns Required Specifies the names of the input table columns that contain the identifiers of the XML documents. No docid_column can have the same name as an output table column. For output column names, refer to Output.
MaxDepth Optional Specifies the maximum depth in the XML tree at which to process XML documents. The MaxDepth and Output arguments determine the schema of the output table, and the number of columns in the output table must not exceed 1600. The default value is 5.
ExcludeElements Optional Specifies the paths to the nodes to exclude from processing. The function excludes each specified node and its child nodes. Examples of paths to nodes are:
  • 'chapter'
  • 'root/book'
  • 'root/book/{author,chapter}'
AttributeAsNode Optional Specifies whether to treat the attributes of a node as its child nodes. The default value is 'false' (attributes of a node are stored in one element of the output tuple).
AttributeDelimiter Optional Specifies the delimiter used to separate multiple attributes of one node in XML documents. The default value is a comma ','.
Output Optional Specifies the output table schema (refer to Example 1: Output Three Different Output Table Schemas). The MaxDepth and Output arguments determine the schema of the output table, and the number of columns in the output table must not exceed 1600. The default value is 'fullpath'.
ErrorHandler Optional Specifies whether the function handles errors that occur when parsing an XML document. The default value is 'false' (the function aborts and throws an exception).

If you specify 'true':

  • If an error occurs while parsing a row, the function skips that row. When the function completes the parsing, it outputs only the nodes that were error-free.
  • You can tell the function to output an additional column named output_column and populate it with the values of the specified columns. In the output column, the values of the specified columns are separated with semicolons.

    For example, the following argument adds the column error_info to the output table and populates it with the values of input columns col1 and col2 (with a semicolon after each value):

    ErrorHandler('true;error_info:col1,col2')

    The default output_column is ErrorHandler.
Accumulate Optional Specifies the names of input column names to copy to the output table. No accumulate_column can have the same name as an output table column. For output column names, refer to Output.