Purpose
This command returns a list of all available BTEQ commands and non-graphic representations of their syntax. When a BTEQ command is specified, an individual syntax and purpose statement are displayed along with the available shorthand syntax for the command as well as its options.
Syntax
| Command | Shorthand | Command | Shorthand | Command | Shorthand |
|---|---|---|---|---|---|
| HELP BTEQ | H | HELP | H | BTEQ | B |
Usage Notes
The HELP command provides accurate spelling and syntax for all BTEQ commands. Optionally, the HELP command can be used for a particular BTEQ command. For example, HELP <cmd>, where <cmd> is any BTEQ command, will give the help content for that command only. The HELP command is not suppressed by the QUIET command.
- Brackets, [ ] indicate optional choices that can be omitted.
- Braces, { } indicate required choices, one of which must be stated.
- A vertical bar | separates different values for options.
- Uppercase characters represent reserved words that must be specified exactly as shown.
- Lowercase characters represent required, user-supplied values.
The HELP command is valid in an SQL macro.
Example 1 – HELP
To request help, type:
.HELP
BTEQ Response
The HELP output is further divided into following categories:
| BTEQ Command-line Arguments | Describes the various command-line options that BTEQ provides. |
| Command Syntax | Describes basic structure of BTEQ input and the conventions followed by the non-graphical syntax representation |
| Shorthand Syntax | Describes available shorthand syntax for BTEQ commands and their determination rules. |
| BTEQ Commands | Lists non-graphic syntax representation of each BTEQ command. |
BTEQ is a general-purpose utility which enables the user to submit Teradata SQL queries to the Teradata Database; it formats the results and returns them to the screen, file, or printer.
Example 2 – HELP Instigated by a Macro
The HELP command in an SQL macro appears as:
ECHO '.HELP';
Example 3 – Command-specific HELP
Use the command-specific HELP syntax to get a detailed help on the purpose of the command as well as the available shorthand for the command and its options.
.HELP AUTOKEYRETRIEVE Syntax: .[SET] AUTOKEYRETRIEVE [OFF|COLUMN|ROW] Purpose: This control enables users to specify whether the database returns values of any fields associated with Identity Data in response to subsequent SQL Insert operations. Shorthand syntax (Interactive mode only): Command - AUTOKEYRETRIEVE AKR Options - COLUMN C | ROW R