5.2.1 Explanation of the specification format and options

Organization of this subsection

(1) Specification format
(2) Explanation of options

(1) Specification format

adbchgchunkcomment
   -u authorization-identifier
  [-p password]
  {-m chunk-comment-to-be-set|-d}
   -c chunk-ID
   table-to-be-processed

Important: You must specify the table to be processed as the last option that is specified.

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 adbchgchunkcomment command. To execute the adbchgchunkcomment command, the user must have the following two privileges:

CONNECT privilege
CHANGE CHUNK COMMENT 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 is 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 adbchgchunkcomment 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.

• -m chunk-comment-to-be-set

~<character string>((1 to 1,024 bytes))

Specifies the text that is to be set as the new or changed comment for a chunk.

Specify this option for a multi-chunk table. An error results if this option is specified for a single-chunk table.

The following rules apply to specifying this information:

The specified comment is case-sensitive.
If the comment contains a character that has a special meaning in the OS or shell, such as a double quotation mark (") or a vertical bar (|), specify the escape character (\) immediately before that character. Alternatively, enclose the entire comment between single quotation marks (').

Example 1: -m abc\|def

Example 2: -m 'abc|def'

In both examples, abc|def is set as the comment.
If a character string is enclosed between double quotation marks (") and then the entire string is enclosed between single quotation marks ('), both the character string and the double quotation marks are treated as the comment.

Example: -m '"abcdef"'

In this example, "abcdef" is set as the comment.
The character encoding specified in the HADB server's ADBLANG environment variable is used as the character encoding for the comment.

• -d

Specifies that the comment set for the chunk is to be deleted. If the adbchgchunkcomment command with the -d option specified is executed for a chunk for which no comment is set, the command terminates normally without deleting any comment.

• -c chunk-ID

~<integer>((1 to 9,223,372,036,854,775,807))

Specifies the chunk ID of the chunk for which a comment is to be set, changed, or deleted.

If a nonexistent chunk ID is specified, the KFAA50294-E message is displayed.

• table-to-be-processed

Specifies the table for which a chunk comment is to be set, changed, or deleted. Specify a multi-chunk table.

The following rules apply to specifying this information:

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

If the user owns this table, the schema name can be omitted. If another HADB user owns this 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 any table for which the user has the CHANGE CHUNK COMMENT privilege.
A single-chunk table cannot be specified.
A viewed table cannot be specified.

To Page Top