12.3.2 Options

Organization of this subsection
(1) -k target-resource
(2) -t {[authorization-identifier.]table-identifier|[authorization-identifier.]all}
(3) -r RDAREA-name
(4) -u authorization-identifier
(5) -X response-monitoring-time-for-server-to-server-communication
(6) -q generation-number
(7) -s server-name
(8) -b
(9) control-information-file-name

(1) -k target-resource

Specifies the type of resource (data pages or index pages) that is to be read into the global buffer.

table:
Specifies that data pages are to be read.
index:
Specifies that index pages are to be read.

(2) -t {[authorization-identifier.]table-identifier|[authorization-identifier.]all}

~<identifier>

Specifies the table name of the target resources.

When you omit the authorization identifier, the user name used to connect to HiRDB is assumed.

When all is specified, the utility reads all tables or indexes (other than temporary tables and temporary table indexes) that belong to an applicable authorization identifier (schema). In this case, the idxname statement cannot be specified.

No data dictionary table, view table, temporary table, or table containing a user-defined abstract data-type column can be specified.

(3) -r RDAREA-name

~<identifier>

Specifies the name of the RDAREA in the table specified in the -t option that is to be read into the global buffer.

This option is applicable to -k table. If you have specified -k index, use the idxname statement to specify this information.

A LOB RDAREA cannot be specified. A batch specification cannot be used.

Criteria
For a table for a HiRDB parallel server configuration whose rows are partitioned among servers, the system performs parallel processing in units of RDAREAs using multiple server processes even when this option is not specified. On the other hand, in the case of a HiRDB single server configuration or a table for a HiRDB parallel server configuration whose rows are partitioned within a server, the system does not perform parallel processing because each RDAREA is processed by one server process. For the latter, you can use this option to perform parallel processing in units of RDAREAs using multiple server processes.

(4) -u authorization-identifier

Specifies the authorization identifier of the user who executes pdpgbfon.

For details about the authorization identifier, see 8.9.2(10) -u authorization-identifier.

(5) -X response-monitoring-time-for-server-to-server-communication

~<unsigned integer> ((1-65535)) <<300>>

If an error, such as a communication error, occurs at the server where the command was executed, the command may stop responding and the application may stop. To detect errors, pdpgbfon enables you to monitor a response time during communication for dictionary manipulation that is performed by the command.

You set in the -X option the response monitoring time during dictionary manipulation (in seconds). If the execution time during dictionary manipulation exceeds the value set in the -X option, pdpgbfon treats it as a dictionary access error and cancels processing with return code 8.

Criteria
  • If you want to detect an error in less time than 300 seconds in the event of a no-response from the server due to a communication error or unit down, specify a smaller value than 300 in the -X option.
  • If the system switchover facility is used, the command may keep waiting for a response even though system switchover has been completed. In such a case, you can terminate the command immediately by reducing the monitoring time.
  • The specified monitoring time may result in a timeout if a response from the dictionary is delayed and if the utility's preprocessing is not completed within 300 seconds, which is the default value of the -X option. This can happen when many applications and utilities are executing concurrently. In such an environment, specify a value greater than 300 in the -X option.

(6) -q generation-number

~<unsigned integer> ((0-10))

When the inner replica facility is used, specifies the generation number of the RDAREA to be read.

Specify the generation number as follows:

0: Original RDAREA is to be read.
1 to 10: Specified generation of the replica RDAREA that is to be read.

For details about the rules, see 11.3.2(9) -q generation-number.

(7) -s server-name

~<identifier>

Specifies the name of the back-end server that is to control execution of pdpgbfon.

This option is applicable to a HiRDB parallel server configuration only (if this option is specified for a HiRDB single server configuration, the option is ignored).

Criteria
Normally, there is no need to specify this option because the system automatically selects one of the back-end servers when the option is omitted.
Specify this option when the maximum number of concurrently activated server processes is exceeded because many instances of pdpgbfon are being executed concurrently.

(8) -b

Specifies that data stored in a branched BINARY-type column in a separate segment is to be read when a table data page is read and the table contains a BINARY-type column whose defined length is 256 bytes or greater.

If the table contains a BINARY-type column with a defined length of 256 bytes or greater and this option is omitted, the utility reads BINARY-type columns stored in the same segment as for a non-BINARY-type column, but not a branched BINARY-type column in a separate segment.

(9) control-information-file-name

~<path name>

Specifies the name of the control information file that contains the control statements for pdpgbfon.

You can specify the following control statements in the control information file; for details about each control statement, see subsections 12.3.3 and 12.3.4; note that comments cannot be specified in a control information file.