Hitachi

Hitachi Advanced Database Setup and Operation Guide


7.3.1 Details of syntax rules for the server definition

The following explains in detail the syntax rules that apply when creating or modifying the server definition.

For details about how to create and modify the server definition, see 8.5 Creating and modifying a server definition.

For details about the specification format of the operands in the server definition and the values to be specified, see the following topics:

Organization of this subsection

(1) Description sequence

Definitions in the server definition can be entered in any order.

(2) Description format

The server definition can be entered in either of the following two formats:

Explanations of these formats follow:

(a) Set format

In the set format, you specify a value for an operand.

Format
set operand = value
operand:

Operand name in the set format

value:

Specified value that corresponds to the operand name. This consists of an alphanumeric character string.

A specification example follows.

Specification example
set adb_sys_max_users = 1024

If the same operand is specified more than once, the value specified for the first one takes effect, and all subsequent values are ignored.

(b) Command format

The specification format for the command format follows.

Format
operand-name option
operand-name:

Operand name in the command format

option:

A character string that begins with a hyphen (-). There are two formats, Format 1 and Format 2.

Format 1
option
Format 2
option option-argument
option:

Consists of a hyphen (-) and a letter. It is case-sensitive.

option-argument:

Argument for the option. This consists of an alphanumeric character string.

A specification example follows.

Specification example
adbbuff -g BUFFER -n ADBUTBL01 -p 1024

(3) Line-ending codes

The following line-ending codes can be used in server definitions:

Note that you cannot use CR (carriage return) alone. If CR is used alone, an error will occur when the HADB server is started.

(4) Line continuation

The maximum length of each line in the definition is 4,000 bytes. Enter any line that exceeds 4,000 bytes over multiple lines.

To indicate that multiple lines are continuations of a single entry, enter a backslash (\) at the end of each line to be continued, followed immediately by a line-ending code. A single-byte space at the beginning of a continuation line is considered to be a significant character and part of the definition.

However, if a backslash (\) is not followed by a line-ending code, the following line is not recognized as being a continuation. Specification examples follow.

Example in which lines are recognized as being continuous
adbbuff -g BUFFER \↓
        -n ADBU01
Example in which lines are not recognized as being continuous
adbbuff -g BUFFER \Δ ↓
        -n ADBU01
Legend:

↓: End of line

Δ: Single-byte space

(5) Character string recognition rule

To specify a double quotation mark (") inside a character string, specify \". In the following example, the character string is recognized as "AREA01".

Specification example
adbbuff -g BUFFER -n \"AREA01\" -p 1024

In some operands (such as the adbbuff operand), you must enclose a character string inside double quotation marks (") for HADB to differentiate between uppercase and lowercase letters. For details, see the description on the operand of interest.

(6) Comment

To enter a comment in the server definition, start the comment with a hash mark (#).

If a line begins with a hash mark (#) as shown in Format 1, the entire line is recognized as a comment.

Format 1
# comment...

To enter a comment following a definition, specify a single-byte space, and then a hash mark (#) as shown in Format 2. If you do not enter a single-byte space, the text following the hash mark will not be recognized as a comment.

Format 2
definitionΔ#comment...
Legend:

Δ: Single-byte space

If the hash mark (#) is located inside a character string enclosed in double quotation marks ("), the character string is not recognized as a comment. The hash mark (#) and the characters that follow it are treated as letters in the character string.

Example in which the hash mark (#) and what follows it are both treated as letters
set adb_db_path = "TESTDBΔ#abc"
Legend:

Δ: Single-byte space

If the hash mark (#) is placed in the middle of a line, the entire character string following the hash mark (#) is treated as a comment. Therefore, be careful about where you place comments if you want to continue an entry across multiple lines. In the following example, the continuation line is treated as part of the comment.

Example in which the continuation line is treated as part of the comment
adbbuff -g BUFFER∆#comment \↓
        -n DBAREA01
Legend:

↓: End of line

Δ: Single-byte space

In the above case, enter Δ#comment after -n DBAREA01.

(7) BOM

You cannot use BOM (Byte Order Mark) in the server definition.

(8) Commas

When you specify multiple character strings for a set format value or command format option argument, use a comma (,) to separate the character strings. Do not enter a single-byte space or line-ending code between a leading character string and a comma. Otherwise, an error occurs during HADB server startup.

Comma specification examples follow.

Correct specification example
set adb_sql_prep_delrsvd_words = ABS,BEFORE,CALL,DATA
 
set adb_sql_prep_delrsvd_words = ABS,ΔBEFORE,[Figure]CALL,[Figure]DATA

When you specify multiple character strings, use a comma (,) to separate the character strings. A single-byte space can be entered between a leading comma and a character string.

Specification example 1 that will cause an error
set adb_sql_prep_delrsvd_words = ABSΔ,BEFOREΔ,CALLΔ,DATA

A single-byte space cannot be entered between a leading character string and a comma. Because this was done in the above example, the specification value is recognized as invalid and an error occurs.

Specification example 2 that will cause an error
set adb_sql_prep_delrsvd_words = ABS,BEFORE↓
                                 ,CALL,DATA

A line-ending code cannot be entered between a leading character string and a comma. An error occurs.

When entering a line-ending code, you must indicate that multiple lines are continuations of a single entry. Enter a backslash (\) at the end of each line to be continued, followed immediately by a line-ending code. Specification examples follow.

Specification examples (to indicate that multiple lines are continuations of a single entry)
set adb_sql_prep_delrsvd_words = ABS,BEFORE\↓
                                 ,CALL,DATA
 
set adb_sql_prep_delrsvd_words = ABS,BEFORE,\↓
                                 CALL,DATA

Enter a backslash (\) as the continuation character between a leading comma and a character string, followed immediately by a line-ending code. In both cases, the lines are recognized as continuations of a single entry.

Legend:

Δ: Single-byte space

↓: End of line