表記規則

このドキュメントは、次の規則に従って記載されています。


文字フォントの使用

他のマニュアルを参照するときはイタリック体で示します。

ドキュメントまたはドキュメントのセクションを参照するときは太字で示します。

ユーティリティの出力例とファイルの内容は、次のようなフォントで示します。

%ADADBM-I-OPENED,  ds DATA2, file DATA2.001 opened
%ADADBM-F-DSSTALL, allocation error DSST

ユーザー入力とユーティリティ出力の両方を示す例は、次のようなフォントで示します。

adadbm: add_container = data, size = 35
%ADADBM-I-OPENED,  ds DATA2, file DATA2.001 opened
%ADADBM-F-DSSTALL, allocation error DSST

構文形式

ユーティリティ制御パラメータの構文は次のとおりです。

大文字の項目はキーワードです。表示どおりに入力する必要があります。キーワードは大文字、小文字のどちらでも入力できます。

小文字の項目はユーザーが選択した値に変換する必要があります。項目が "number" の場合、10 進数を指定します。正の数か 0 だけを指定できます。負の数は指定できません。項目が "string" の場合、テキスト文字列、つまり英数字の文字をいくつでも指定できます。数字または文字列の場合は、"0x"、"0X" で始まる 16 進値を指定することもできます。"^x" または "^X"。16 進数で指定された数字の場合、先頭の 0 は省略できます。他の項目が出現することもあります。例えば "descriptor" とあれば、ディスクリプタ名を入力する必要があります。

角カッコ([ ])で囲まれた項目はオプションです。

中カッコ({ })で囲まれた項目は必須です。

垂線(|)は複数の項目を区切ります。項目のどれか 1 つだけを指定する必要があります。

省略記号(...)は、省略記号の直前の構文要素を繰り返し記述できることを示します。

コンマの後の省略記号(,...)は、省略記号の直前の構文要素を、コンマで区切って繰り返し記述できることを示します。

要素のリストに丸カッコを使用してキーワードを 1 つだけ指定する場合、指定する要素が 1 つだけであれば丸カッコを省略できます。

例 1

RB=0x33445566

ここでは、文字列の値が 16 進数の文字列として指定されています。これは、ASCII 文字列 "3DUf" と同等の出力可能な文字で構成されています。

例 2

DBID = number

この例では、キーワード "DBID" を大文字、小文字、またはその組み合わせで入力し、= 文字と 10 進数が後に続いています。例えば、次のように入力します。

DBID = 27

例 3

RABN = number [ - number]

この例では、キーワード "RABN" を大文字、小文字、またはその組み合わせで入力し、= 文字と 10 進数が後に続いています。ハイフン(-)とそれに続けて 10 進数を追加できますが、これは必須ではありません。この構文に当てはまる入力例を次に示します。

RABN = 25
RABN = 1000 - 1125

例 4

RABN = 0x400

この場合、値は 16 進数値として指定されています。これは以下の指定と同等です。

RABN = 1024

例 5

SORTSEQ = { descriptor | ISN }

この例では、キーワード "SORTSEQ" を大文字、小文字、またはその組み合わせで入力し、次に = 文字、ディスクリプタ値かキーワード "ISN" のどちらか一方が続いています。

SORTSEQ = ISN

例 6

number[-number] [,number[-number] ] ...

この例は、省略記号(...)の使用例です。省略記号は構文要素の "[,number[-number] ]" の後に続きます。つまり、この構文要素を入力行に何回でも繰り返すことができます。この構文に当てはまる入力例を次に示します。

27
27-50
27-50,68
27,68-90
27-50,68-90
27-50,68-90,102,105,118-140,160

例 7

例 4 の代わりとして、(,...)を使用して次の構文も指定できます。

{ number[-number] },...

この構文によって、例 4 のすべての組み合わせが可能です。

例 8

(number[,number]...)

この構文に有効な入力例は次のとおりです。

(12,23,45)
(123)
123 - only one list element, so brackets can be omitted

大文字変換

指定されたパラメータ名は常に大文字に変換されます。

ほとんどのユーティリティ制御パラメータでは、指定されたパラメータ値も大文字に変換されますが、これは必ずしも望ましい動作ではありません。Adabas バージョン 6.1.6 以降では、制御パラメータ値の大文字変換の新しい規則が導入されました。

  • parameter=value」を指定すると、値は大文字に変換されます。

  • parameter:value」を指定すると、値は大文字に変換されません。

パラメータ名の後にコロンまたは等号を指定するオプションは、通常、パーサーを通じてすべてのパラメータに対して指定されますが、Software AG では、構文で明示的に記述されているパラメータに対してのみコロンを指定することを推奨しています。これは、明示的に記述されているパラメータに対してのみ、上記の動作が保証されていることが理由です。つまり、以前の Adabas バージョンとの互換性の理由により、その他のパラメータの一部では大文字変換の処理が異なっています。

次の構文を想定します。

NAME{=|:}string

次のように指定した場合

NAME=Production

NAME のパラメータ値は "PRODUCTION" に設定されます。

次のように指定した場合

NAME:Production

NAME のパラメータ値は "Production" に設定されます。

ただし、フィールド、ディスクリプタ、参照制約の定義など、一部のユーティリティ入力は "パラメータ{=|:}値" として提供されません。定義の前にパラメータ LOWER_CASE_FIELD_NAMES が指定されていない限り、指定はデフォルトで大文字に変換されます。

注意:
LOWER_CASE_FIELD_NAMES を指定すると、いずれの定義も大文字に変換されません。この場合は、フィールドオプションなどのキーワードを大文字で指定する必要があります。

LOWER_CASE_FIELD_NAMES を指定しない場合、フィールド定義

1,aa,8,a,de

は正しく、次と同等です。

1,AA,8,A,DE

ただし、LOWER_CASE_FIELD_NAMES を指定した場合、このフィールド定義は無効です。フィールド "aa" を定義するには、次を指定する必要があります。

1,aa,8,A,DE

フィールド指定

いくつかのユーティリティには、Adabas フィールドを指定できるパラメータが含まれています。フィールド指定の正確な構文は、対象とするパラメータによって異なります。例えば、ADAINV INVERT の場合は、フィールド名の指定で十分ですが、ADADBM ADD_FIELD の場合は完全なフィールド定義が必要です。

これらのフィールド指定は、END_OF_FIELDS パラメータで終了できます。

注意:

  1. LOWER_CASE_FIELD_NAMES を指定した後では、END_OF_FIELDS パラメータを大文字で指定する必要があります。
  2. ADACMP および ADADCU では、END_OF_FIELDS の代わりにピリオド(.)を指定できます。

ユーティリティのパラメータ指定の最後では、END_OF_FIELDS を省略できます。フィールド指定の後に他のパラメータを追加する場合は、END_OF_FIELDS が必要です。

注意:
V6.3 SP3 より前の Adabas バージョンでは、一部のユーティリティで、パラメータ指定の最後に END_OF_FIELDS が必要でした。END_OF_FIELDS が見つからないと、機能は実行されませんでした。

制御パラメータに使用するシンボルの要約

各ユーティリティの説明の中に、そのユーティリティで使用できる制御パラメータの構文をまとめた表が記載されています。一部の制御パラメータの先頭には、文字 M または D が付いています。

文字 M は必須であることを示します。つまり、このパラメータをユーティリティの入力に指定しないとユーティリティは実行できなくなります。文字 M がない場合、そのパラメータは任意指定なので、指定しなくても構いません。

文字 D は、制御パラメータにデフォルト値があることを示します。つまり、このパラメータを明示的に指定しないと、パラメータに事前に設定されている値がそのユーティリティで使用されます。

パラメータの順序

ユーティリティのパラメータは、アルファベットの順にドキュメントに示されます。しかし、パラメータによっては、パラメータの指定順序に制限があります。通常、DBID パラメータは最初に指定します。また、ユーティリティによっては多くの制限があります。

特に多機能ユーティリティの場合、機能を直ちにトリガするパラメータがいくつかあります。このようなパラメータの後に指定された他のパラメータは無視されます。ただし、後で別の機能を指定した場合は、これらのパラメータが使用されます。

例:

adavfy dbid=34 file=9 index file=11 data

パラメータ INDEX によりインデックス検証がトリガされます。このパラメータには、先行する "file=9" の指定が影響します。DATA パラメータによりデータ検証がトリガされます。このパラメータには、先行する "file=11" の指定が影響します。このコマンドでは、ファイル 9 のインデックス検証とファイル 11 のデータ検証がトリガされます。

数値

数値は次の方法で指定できます。

  • 番号

  • number[K](実際の値は指定した数値の 1024 倍)

  • number[M](実際の値は指定した数値の 1024*1024 倍)

number[K] および number[M] は、大きな数値を指定する場合のみ使用できます。

最大値

Adabas の制限により固定的な限界値がある場合にだけ、数値パラメータの最大値について説明します。符号ありまたは符号なしの 4 バイト整数が変数の格納に使用されるときの制限値については、説明しません。この場合、制限値が最大の可能な整数よりわずかに小さくなることがあるからです(例えば 4000 M)。

HTML ドキュメントでの構文図

各ユーティリティの最初に構文図があります。それらの構文図には、利用可能なキーワードとパラメータの詳細な記述へのリンクを含んでいます。構文図のハイパーリンクには、強調のために下線が引かれていますが、下線は構文の一部ではありませんので注意してください。

処理フロー

ユーティリティのドキュメントには、ユーティリティがアクセスするファイルを示す処理フロー図が含まれています。ユーティリティは、データベースコンテナにアクセスする際に、コンテナの場所を確認するために、ADABAS.INI および DBnnn.INI ファイルも読み取ります。シンプルな図を維持するため、ADABAS.INIDBnnn.INI は、修正された場合にのみ記述されています。

廃止されたパラメータ

場合によっては、Adabas の新しいバージョンがリリースされたときに、ユーティリティやニュークリアスのパラメータが廃止されることがあります。通常、ユーティリティまたはニュークリアスは、廃止されたパラメータを以前と同様に受け入れますが、次のような PAROBS 警告が表示されます。

%ADANUC-W-PAROBS, parameter NH has become obsolete