Understanding command syntax
Before creating your script, you need to understand the required syntax for using the CHCCLP commands.
Command formats
For each command, the following items of information are provided:- Syntax and syntax diagram
- Identifies the name of the command and lists the command parameters.
- Parameters
- Describes each parameter in the command and identifies the values that can be specified.
- Result
- Indicates the values that are returned by the command if it is successful. This section also specifies the information that is displayed on the screen, if any, as a result of executing the command.
- Examples
- Provides one or more examples of invoking the command.
Parameter formats
Note the following conventions in the definition of the command parameters:- Square brackets ( [ ] ) indicate an optional parameter. If you omit the parameter, CDC Replication uses a default value. If there are no square brackets surrounding a parameter, the parameter is mandatory
- Angle brackets ( < > ) indicate a placeholder for the parameter. You will need to include a value for this placeholder when the parameter is specified.
Using quotation marks in CHCCLP commands
Use double quotation marks around parameter values that contain special characters or syntax keywords, or around empty strings.
The following text is an example of setting a description for a subscription with spaces:
add subscription name TEST description A test subscription
;If the parameter value contains double quotation marks, use single quotation marks around the value. Parameter values cannot contain a mixture of single and double quotes.
The following text is an example of setting descriptions that contain single or double quotes:
add subscription name TEST description 'A test
subscription';
add subscription name TEST description A 'test' subscription
;