15.11 - Command-Line Interface Overview - Data Stream Architecture

Teradata Data Stream Architecture (DSA) User Guide

Data Stream Architecture
December 2016
User Guide

DSA provides a command-line interface that enables you to carry out the same actions that can be carried out in the BAR Setup and BAR Operations portlets, plus additional commands that are not available in the portlets. The DSA command-line interface includes setup commands for configuring, updating, and deleting targets, sources, and the DSC repository. The command-line interface also includes operations commands for creating, running, and monitoring jobs.

You can run the commands on an ad hoc basis, as an alternative to using the portlets. You can switch between the command-line and portlet interfaces. For example, you can create jobs in the portlet and then view them using the list_jobs command. Or you can export the XML file associated with a job you created in the portlet, and update the job definition using the command line. You can also develop scripts to automate DSA commands and to use with UNIX cron or other job-scheduling applications. For example, you might want to have a backup job run automatically every night at 1 a.m.

Each command has a number of parameters that can be specified directly in the command line to run the command. In addition, many of the commands require that additional information necessary to carry out the commands be specified in an XML file. Sample XML files for system and component configuration and for job definition are located at $BARCMDLINE_ROOT/samples. The sample files include helpful comments and show the available settings for the commands to which they correspond.