Command Syntax
- Last UpdatedJan 24, 2023
- 2 minute read
The Command Syntax section gives detailed information on how to use the relevant commands for using Query to communicate with other data servers.
The commands described in the main part of this section have their legal command and interrogation options presented in the form of syntax diagrams. These diagrams formalize the precise command sequences which may be used and supplement the explanations given in the appropriate sections of this manual.
The following conventions apply to the syntax diagrams in this section:
-
Names written in lowercase letters enclosed in angled brackets (e.g. <direction>) represent subsidiary syntax diagrams. Such names are used for cross‑reference purposes within other syntax diagrams.
-
Commands to be input from the terminal are shown in a combination of uppercase and lowercase letters. In general, these commands can be abbreviated; the capital letters indicate the minimum permissible abbreviation.
Note:
Using this convention does not mean that the second part of the command must be typed in lowercase letters; commands may be entered in any combination of uppercase and lowercase letters.
For example, the command CONnect may be input in any of the following forms:
CON
CONN
CONNE
CONNEC
CONNECT
Commands shown wholly in uppercase letters cannot be abbreviated.
-
Names written in lowercase italics are command arguments.
-
Syntax diagrams are generally read from top left to bottom right.
-
Points marked with a plus sign (+) are option junctions which allow you to input any one of the commands to the right of the junction.
>---+--- ABC -----.
| |
|--- PQR -----|
| |
|--- <dia> ---|
| |
‘-------------+--->
This means the User can type in 'ABC' or 'PQR' or any command allowed by the syntax given in subsidiary syntax diagram '<dia>' or just press Return to get the default option.
-
Points marked with an asterisk (*) are loop back junctions. Command options following these may be repeated as required.
.-----<-------.
/ |
>---*--- option1 ---|
| |
|--- option2 ---|
| |
‘--- option3 ---+--->
This permits any combination of 'option1' and/or 'option2' and/or 'option3' to be used (where the options may define commands, other syntax diagrams, or command arguments). Using this may form an exception to the rule of reading from top left to bottom right.
The simplified format means that you may type in a list of names, separated from each other by at least one space.
.----<-----.
/ |
>---*--- name ---+--->
Note:
The need to press the Return (or Enter) key to complete each command line is implicit in all syntax diagrams and is not
usually shown. Only in cases where the need to press Return/Enter has some particular significance is this indicated specifically by the abbreviation
'nl'.