In this documentation, the following standard notation conventions are used when presenting the syntax for SAND CDBMS commands:
- Text in normal font represents command keywords, which must be entered as shown. For example:
nconfig
- Italics are used to represent general parameter information and data object categories in a statement syntax; they indicate that the user should supply the appropriate entry. For example, the clause
nconfig database-name
contains the command keywordnconfig
, and the parameterdatabase-name
(indicating that the user should supply the name of a database).
- Parentheses (
()
) and quotation marks ( ", ' ) appearing within the statement syntax are part of the statement syntax, and must be typed as shown.
- Angle brackets ( < > ) enclose item descriptions whose syntax is expanded in a following sub-section. Neither the brackets nor the enclosed words should be typed.
- Square brackets ( [ ] ) enclose optional items in a command statement. Do not type the brackets. For example, the SQL command
ROLLBACK [ WORK ]
indicates that the keywordROLLBACK
must be used, while the additional keywordWORK
is optional.
- Vertical bars ( | ) indicate that the optional item preceding the bar can be replaced by the optional item following the bar. This character operates as an OR conjunction, offering a choice between the items that appear before and after it. Do not type the vertical bar.
- Braces ( { } ) surrounding items separated by a vertical bar indicate that one of these items must be selected as a single element of the command statement. For example, "{A | B}" means "choose either A or B." Do not type the braces. If braces surround items that are not separated by a vertical bar, they indicate a group of items that can be repeated, as described below.
- Ellipses ( ... ) indicate that the immediately preceding item may be repeated one or more times without separators. If more than one element is to be repeated (for example, if a comma must be used as a separator in a list), the repetitive items are enclosed by braces ({ }), as in the following example:
[ { , value-expression [ [AS] alias ] } ... ]
This indicates that value expressions and their optional alias names can be listed, with each expression/alias pair separated by a comma.
- Underlined items indicate a default option. For example,
SELECT [ ALL | DISTINCT ]
indicates thatSELECT
(by itself) is interpreted in the same fashion asSELECT ALL
.