You display the explanatory text for a DBM command that is available online. This explanation text can be modified by specifying options.
You do not need to log on to the Database Manager as an operator to execute this DBM command.
explain <dbm_command> <option>
<option> :: = <command_option> [-nolinewrap | -longinfo]
Options
Option |
Description |
<dbm_command> |
DBM command |
<command_option> |
Command option that is to be specified for this DBM command |
-nolinewrap |
Line break in the explanatory text is suppressed |
-longinfo |
Only relevant for programming DBM client programs, shows the informative long text for permitted values |
OK
<explain_text>
<explain_text> |
Explanatory text |
Logging on to the Database Manager CLI as operator OLEG with password MONDAY, connecting to the database instance DEMODB, displaying the complete explanatory text for the DBM command auto_extend:
>dbmcli –u OLEG,MONDAY –d DEMODB explain auto_extend
OK
With this command, the database instance can be configured to automatically
create new data volumes, when the degree of filling reaches a certain limit.
Size and location of the new data volume are determined as explained in
DBMServer command db_addvolume.
Preconditions:
You have the server authorization ParamFull or AccessUtility.
Syntax:
auto_extend <mode> [<percentage>]
Options:
<mode>
New mode for the database. Possible values are:
ON activate automatic database extension
OFF deactivate automatic database extension
SHOW show current status of automatic database extension
<percentage>
Limit of degree of filling of the database instance, at which a new
data volume should be added. 1 <= <percentage> <= 100 must be true.
Default is 90. Use only with <mode> ON.
Reply:
OK
[ON <percentage>|OFF[, <reason>]|UNKNOWN]
Meaning of the individual fields of the reply:
ON
Automatic database extension is activated (only if <mode> is SHOW).
<percentage> is the actual degree of filling of the database
instance, at which a new data volume is added in the current
configuration.
OFF
Automatic database extension is deactivated (only if <mode> is
SHOW)
UNKNOWN
Status of automatic database extension is unknown (only if <mode>
is SHOW)
Logging on to the Database Manager CLI as operator OLEG with password MONDAY, connecting to the database instance DEMODB, displaying the complete explanatory text for the option percentage for the DBM command auto_extend:
>dbmcli –u OLEG,MONDAY –d DEMODB explain auto_extend percentage
OK
Limit of degree of filling of the database instance, at which a new data volume should be added. 1 <= <percentage> <= 100 must be true. Default is 90. Use only with <mode> ON.