16.2.2 Options
- -u authorization-identifier
Specifies the authorization identifier used for connecting to HiRDB. If omitted, the value set in the PDUSER environment variable is assumed. If the PDUSER value is not set, the user name corresponding to the user ID in the OS that is being used to execute this utility is assumed.
If a user ID is enclosed in double quotation marks ("), it is handled as case sensitive; otherwise, it is handled as all uppercase letters. If you use the Bourne shell (sh), C shell (csh), or Korn shell (ksh), it is also necessary to enclose the user ID in single quotation marks.
- -a authorization-identifier
Specifies the authorization identifier of the owner of the table that is to be subject to collection of optimization information.
If omitted, the authorization identifier assigned by the -u option is assumed.
If an authorization identifier is enclosed in double quotation marks ("), it is handled as case sensitive; otherwise, it is handled as all uppercase letters. If the Bourne shell (sh), C shell (csh), or Korn shell (ksh) is used, it is also necessary to enclose the authorization identifier in single quotation marks.
- -p password
Specifies the password for the user ID specified in the -u option.
If the -u option is specified but the -p option is omitted, the user is requested to enter a password, and the entered value is used; if entry of a password is not required, the NULL SEND button should be pressed.
If the -u and the -p options are both omitted, the value set in the PDUSER environment variable is assumed; if the PDUSER value is not set, the user is requested to enter a password, and the entered value is used; if entry of a password is not required, the NULL SEND button should be pressed.
This utility must not be executed in an environment in which a required password cannot be entered, such as background execution with a shell using &. Password entry is required in the following cases:
- -u option specified and -p option omitted
- -u and -p options both omitted and no password set in the PDUSER environment variable
If a password is enclosed in double quotation marks ("), it is handled as case sensitive; otherwise, it is handled as all uppercase letters. If the Bourne shell (sh), C shell (csh), or Korn shell (ksh) is used, it is also necessary to enclose the password in single quotation marks.
- -t {table-identifier|ALL}
- table-identifier
- Specifies the identifier of the table that is to be subject to collection of optimization information.
- You cannot specify a data dictionary table, view table, or temporary table. If pdgetcst is executed with a table of any of these types specified, the KFPN00202-E message is issued and pdgetcst terminates with an error.
- If the table identifier is enclosed between double quotation marks ("), it is treated as being case sensitive; otherwise, it is handled as all uppercase letters. Note also that if the table identifier contains a space, the entire identifier must be enclosed between double quotation marks (").If you are using sh (Bourne shell), csh (C shell), and ksh (Korn shell), you need to enclose the entire identifier in single quotation marks (').
- ALL
- Specifies that all tables in the schema are to be subject to processing. Note that pdgetcst cannot process data dictionary tables, view tables, or temporary tables.
- -d
Specifies that existing optimization information for the table specified with the -t option and for indexes defined for that table is to be deleted.
- -c {lvl1|lvl2}
Specifies the optimizing information collection level.
For details about the optimizing information collection level, see 16.3.3 Optimizing information collection levels.
- lvl1
- Collects the number of rows in the table and the statistical information cache size.
- lvl2
- Collects all optimizing information for the table.
- -s optimization-information-parameter-filename~<pathname>
Specifies the absolute pathname of the optimization information parameter file containing the optimization information. When this option is specified, the utility registers the optimization information from the specified parameter file without collecting it from the current database status. When this option is specified, the -d option cannot be specified.
- -l output-result-filename~<pathname>
Specifies the absolute pathname of the file to which the result of the optimizing information collection utility is to be output. When this option is omitted, the execution result is not output.
If you specify -t ALL along with this option, and pdgetcst results in an error, you can identify the table resulting in the error.
- -q generation-number ~<unsigned integer> ((0-10))
When an RDAREA with replica RDAREAs is to be subject to collection of optimization information, specifies the generation of the target RDAREA.
When this option is omitted, the command assumes the current RDAREA. The command also assumes the current RDAREA if the specified generation has no replica RDAREA.
An error results if this option is specified when the inner replica facility is not used. Specifying this option also results in an error if there is no replica RDAREA of the index storage RDAREA or LOB column storage RDAREA that corresponds to the table storage RDAREA with the specified generation.
- -v space-conversion-level
Specifies whether spaces are to be converted in maximum and minimum column values and in maximum column values in a section.
When this option is omitted, the utility executes space conversion according to the pd_space_level operand specification in the system common definitions.
For the space conversion level, specify 0, 1, or 3:
- 0
- Space conversion is not executed.
- 1 or 3
- Space conversion is executed. 1 and 3 have the same effects.
- If the table columns to be registered have the national character string type or mixed character string type, the utility converts spaces in the corresponding optimizing parameter file as follows:
- Column of national character string type
The utility converts two consecutive single-byte spaces to one double-byte space, in units of two bytes from the top.
- Column of mixed character string type
The utility converts each double-byte space to two single-byte spaces.
When the character codes are utf-8, the system converts one double-byte space (3 bytes) to two single-byte spaces. For MCHAR, the system adds trailing single-byte spaces up to the definition length. For MVARCHAR, the data length remains shortened.
- -e optimization-information-parameter-filename ~<pathname>
Specifies the absolute path name of the file in which optimization information is to be saved.
- Rules
- Optimization information cannot be saved if it has not been registered in the data dictionary table.
- If the file specified in the -e option already exists, the utility outputs the KFPN00015-I message and saves the optimization information by overwriting the existing file.
- If no optimization information has been registered in the data dictionary table and the file specified in the -e option already exists, the utility deletes the existing file but does not create the file whose name is specified in the -e option. In such a case, the utility outputs the KFPN00015-I message.
- You can re-register into the data dictionary table the optimization information parameter file specified in the -e option only if the table definitions match. If the table definitions do not match, re-registration might not be successful. For details, see Using a parameter file that contains optimized information after table and index definitions are modified in the HiRDB Version 9 System Operation Guide.
- -W execution-monitoring-interval ~<unsigned integer> ((0 to 3600))
Specifies (in minutes) the monitoring interval when the execution time of the optimizing information collection utility is to be monitored.
For guidelines on the value to specify and details about the resulting operation, see the description of the pd_cmd_exec_time operand in the system common definition in the manual HiRDB Version 9 System Definition.
If 0 is specified in this option, the utility's execution time is not monitored.
If this option is omitted, the value of the pd_cmd_exec_time operand in the system common definition takes effect.