15.2.1 Explanation of the specification format and options

(1) Specification format

adbgetcst
    -u authorization-identifier
   [-p password]
   [-t table-name]
   [-d]
   [-z cost-information-collection-options-file-name]
   [-g output-interval-for-cost-information-collection-progress-message]

To Page Top

(2) Explanation of options

• -u authorization-identifier

~<character string>((1 to 100 bytes))

Specifies the authorization identifier of the HADB user who executes the adbgetcst command. You must have the following two privileges to execute the adbgetcst command:

• CONNECT privilege

• GET COSTINFO privilege for the table to be processed

For this option, specify an authorization identifier in the range from 1 to 100 bytes. Note that the byte count (1 to 100 bytes) does not include the double quotation marks used to enclose the authorization identifier.

Important

If the character string used as the authorization identifier includes any lowercase letter or a backslash (\), make sure that you check the rules for specifying authorization identifiers. For the rules for specifying authorization identifiers, see 1.4.2 Rules for specifying authorization identifiers and passwords.

• -p password

~<character string>((1 to 255 bytes))

Specifies the password for the authorization identifier that was specified in the -u option.

Important

If the password includes a character that has a special meaning in the OS or shell, such as a double quotation mark (") or vertical bar (|), make sure that you check the rules for specifying passwords. For the rules for specifying passwords, see 1.4.2 Rules for specifying authorization identifiers and passwords.

If the adbgetcst command is executed with this option omitted, a message prompting the user to enter a password is displayed. In an environment in which a password cannot be entered from the standard input, such as when the command is executed in the background, make sure that you do not omit this option.

• -t table-name

~<character string>

Specifies the table name of the table for which cost information is to be collected. When the -d option is specified, specify the table name of a table whose cost information is to be deleted from the system tables (base tables).

If this option is omitted, the adbgetcst command processes all tables defined in the schema having the authorization identifier specified by the -u option.

The following rules apply to specifying this option:

• Specify in the format schema-name.table-identifier.

  If the user owns the table, the schema name can be omitted. If another HADB user owns the table, the schema name must be specified.

• For details about the specification rules that apply when a schema name or table identifier includes any lowercase letter or backslash (\), see 1.4.3 Table name specification rules.

• The user can specify only a table for which the user has the GET COSTINFO privilege.

• A viewed table cannot be specified.

• -d

Specifies that cost information is to be deleted from the system tables (base tables).

If there is no cost information in the system tables (base tables), the command skips deletion processing.

• -z cost-information-collection-options-file-name

~<OS path name>((2 to 510 bytes))

Specifies the absolute path name of the cost-information collection-options file that contains an option for cost-information collection processing. If this option is omitted, the cost information collection option is set to its default value because no cost-information collection-options file is specified.

For details about the cost information collection option, see 15.2.2 Format of the cost-information collection option.

• -g output-interval-for-cost-information-collection-progress-message

~<integer>((0 to 1,000,000,000))<<0>>(in 1,000 rows)

Specifies the output interval for the cost information collection progress message. For example, if 2 is specified in this option, the progress message (KFAA80205-I) is output each time 2,000 rows of cost information are collected.

If this option is specified and the -t option is omitted, the progress message is output for each table that is processed.

If this option is omitted or 0 is specified in this option, the progress message is not output.

This option is ignored when the -d option is specified.

To Page Top