Skip to Content

Reading the syntax diagrams

Syntax diagrams define primary command syntax.

  • A parameter is either a keyword or a variable.
    • All KEYWORDs are shown in uppercase characters and must be spelled exactly as shown. You cannot substitute another value. If any part of a KEYWORD is shown in lowercase characters, that part is optional.
    • Variables are user-specified values and are printed in lowercase italics. For example, dataset-name indicates you are to substitute a value.

The syntax for commands is described in diagrams that help you visualize parameter use. The following example shows a command and a parameter:

image2021-4-12_15-30-54.png

Read the diagrams from left to right and from top to bottom. These symbols help you follow the path of the syntax:

image2022-9-21_12-27-38.png

indicates the beginning of a statement.

image2022-9-21_12-27-54.png

indicates the statement is continued on the next line.

image2022-9-21_12-28-11.png

indicates the statement is continued from the previous line.

image2022-9-21_12-28-32.png

indicates the end of a statement.

Required parameters appear on the horizontal line (the main path). Optional parameters appear below the main path. Default parameters appear above the main path and are optional. The command executes the same whether the default parameter is included or not.

image2021-4-12_15-31-46.png

Vertically stacked parameters are mutually exclusive. If you must choose a parameter, one item of the stack appears on the main path. If the parameters are optional, the entire stack appears below the main path. If a parameter in a stack is the default, it appears above the main path.

image2021-4-12_15-32-11.png

If the same parameters are used with several commands their syntax may be documented in a separate diagram. In the command syntax, these common parameters are indicated with separators before and after the parameter name.

image2021-4-12_15-32-42.png

An arrow returning to the left indicates a repeatable item. If the arrow contains a comma, separate the repeated items with a comma.

image2021-4-12_15-33-9.png

Partial column names

If a primary command allows a parameter of column-name, you can specify a partial column name instead of the entire name. Simply enter at least the first character of the column’s name. Do not use a wild card character. For example, to locate the column FIRSTNME, enter LOCATE F in the COMMAND field. If the partial name qualifies more than one column, a window displays the matching column names allowing you to select one.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC AMI DevX File-AID for Db2 23.01