Syntax statements

The following information explains the conventions for syntax statements used in this documentation.

Sample statements follows:

COMMAND KEYWORD1 [KEYWORD2 | KEYWORD3] KEYWORD4={YES | NO} fileName...

COMMAND <KEYWORD1> [<KEYWORD2> | <KEYWORD3>] <KEYWORD4>={YES | NO} <fileName>...

Conventions

Convention

Example

Items in italic type or enclosed by angle brackets (< >) represent variables that you must replace with a name or value. If a variable is represented by two or more words, initial capitals distinguish the second and subsequent words.

alias

databaseDirectory

<serverHostName>

Brackets indicate optional items. Do not type the brackets when you enter the option. A comma means that you can choose one or more of the listed options. You must use a comma to separate the options if you choose more than one option.

[tableName, columnName, field]

[-full, -incremental, -level]

Braces indicate that at least one of the enclosed items is required. Do not type the braces when you enter the item.

{DBDName | tableName}

UNLOAD device={disk | tape, <fileName> | <deviceName>}

{-a | -c}

A vertical bar means that you can choose only one of the listed items. In the example, you would choose either commit or cancel.

{commit | cancel}

An ellipsis indicates that you can repeat the previous item or items as many times as necessary.

columnName

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments