DELETE 時
3.1 ユティリティの使用方法
この節では,XML Extension が提供するユティリティの使用方法について説明します。
3.1.1 XML Extension のユティリティとは
XML Extension では,XML Extension の設定,管理および運用のためにユティリティを提供していま す。ユティリティは,XML Extension を登録したマシン上で実行します。
XML Extension のユティリティは,HiRDB のクライアント(UAP)として動作します。このため,事前 にクライアント環境定義を設定してください。なお,クライアント環境定義 PDUSER には,DBA 権限の ある認可識別子を設定してください。クライアント環境定義については,マニュアル「HiRDB UAP 開発 ガイド」を参照してください。
また,XML Extension の運用中には,XML Extension のユティリティ以外に,HiRDB で提供されてい るユティリティや運用コマンドを使用する場合があります。HiRDB で提供されているユティリティおよび 運用コマンドの使用方法については,マニュアル「HiRDB コマンドリファレンス」を参照してください。
XML Extension が提供する XML データ検索プラグインのユティリティの機能一覧を,次の表に示しま す。なお,「phdxmlcnv(XML データ変換コマンド)」については「5. XML 変換ライブラリ」を参照し てください。
表 3‒1 XML Extension が提供する XML データ検索プラグインのユティリティの機能一覧
プラグイン種別 ユティリティコマン ド名
機能 ユティリ
ティコマン ドの実行者
HiRDB 稼働中で の実行 可否
実行する HiRDB 運用環境
XML デー タ検索プラ グイン
XML データ 型プラグイン
phdxmlcnv XML データ
ファイルを XML データ 検索用ファイ ルに変換
HiRDB 管 理者
− 任意
phdsyndicreg 同義語辞書の
登録
HiRDB 管 理者
○ XML Extension を登録し たすべての HiRDB 運用 環境※1
phdsyndicrm 同義語辞書の
削除
HiRDB 管 理者
○ XML Extension を登録し たすべての HiRDB 運用 環境※1
phdsyndicconv 同義語辞書の
移行
HiRDB 管 理者
○ XML Extension を登録し たすべての HiRDB 運用 環境※1
プラグイン種別 ユティリティコマン ド名
機能 ユティリ
ティコマン ドの実行者
HiRDB 稼働中で の実行 可否
実行する HiRDB 運用環境
phdsyndicbkup
(UNIX の場合)
同義語辞書の バックアップ
HiRDB 管 理者
× XML Extension を登録し たすべての HiRDB 運用 環境※1
phdrulecheck 統制ルール
チェックユ ティリティ
HiRDB 管 理者
○ XML Extension を登録し たすべての HiRDB 運用 環境※1
IXXML イン デクス型プラ グイン
phjidxls インデクス情
報の取得
HiRDB 管 理者
○ SDS または MGR
phjincmt※2 インデクスの
インクリメン タル(最適化)
ユティリティ
HiRDB 管 理者
○ SDS または MGR
phjincrword 文字列指定イ
ンクリメンタ ルユティリ ティ
HiRDB 管 理者
○ SDS または MGR
phjexpnd インデクスの
拡張
HiRDB 管 理者
○ SDS または MGR
phjstartidx インデクスの
作成開始
HiRDB 管 理者
○ SDS または MGR
phjdelay インデクス分
割遅延登録運 用変更
HiRDB 管 理者
○ SDS または MGR
phjmodidx インデクス情
報変更
HiRDB 管 理者
○ SDS または MGR
phjcond インデクス詰
め替え
HiRDB 管 理者
○ SDS または MGR
(凡例)
○:HiRDB が稼働中のときだけ実行できます。
×:HiRDB が停止しているときだけ実行できます。
−:HiRDB の稼働/停止に関係なく実行できます。
SDS:HiRDB/シングルサーバの場合に,シングルサーバがあるサーバマシンで実行することを示します。
MGR:HiRDB/パラレルサーバの場合に,システムマネジャがあるサーバマシンで実行することを示します。
注
ユティリティの実行時に指定したファイルを,ほかのユティリティまたは UAP で同時に使用しないでください。同じファイ ルをユティリティまたは UAP で同時に使用した場合は,処理結果が誤りとなったり,エラーが発生したりすることがあります。
注※1
XML データ型プラグインを登録したすべての HiRDB 運用環境に対して,同一の操作をしてください。
注※2
英文インデクスは指定できません。
3.1.2 ユティリティの記述形式と操作
ここでは,ユティリティの入力方法と記述形式について説明します。なお,ユティリティは,open 状態 かつ HiRDB の運用コマンド「pdhold(RD エリアの閉塞)」による閉塞状態か,open 状態かつ閉塞解除 状態のどちらかのときに実行してください。
(1) ユティリティの記述形式
ユティリティは次の形式で記述します。
ユティリティコマンド名 オプション コマンド引数
(a) ユティリティコマンド名
ユティリティコマンド名は,実行するユティリティコマンドのファイル名です。各ユティリティコマンド を格納しているディレクトリ名については,「付録 B ディレクトリおよびファイル構成」を参照してくだ さい。
(b) オプション
オプションで指定するのは,ユティリティコマンドの操作そのものを修飾するか,または操作の対象物を 特定するために,対象物を修飾するかのどちらかです。
次の説明中に使用する$はシェルのプロンプト,cmd はユティリティコマンド名を示します。
• オプションは,「−」(マイナス記号)で始まる文字列で,フラグ引数を指定しないか,または 1 種類の フラグ引数を指定します。
オプションの記述形式を次に示します。
−オプションフラグ または
−オプションフラグ フラグ引数
(凡例)
オプションフラグ:
1 文字以上の英数字(英大文字と英小文字は区別されます)
フラグ引数:
オプションフラグに対する引数
• フラグ引数のないオプションフラグは,一つのマイナス記号の後ろにまとめて指定できます。
$ cmd -a -b -c $ cmd -abc
• フラグ引数を必要とするオプションフラグのフラグ引数は,省略できません。
• フラグ引数中にあるスペースを含める場合(UNIX の場合は,シェルから入力するとき)は,フラグ引 数の前後を「"」(ダブルクォーテーション)で囲まなければなりません。
(例)
1 2 を引数に持つオプション f は,次のように記述します。
$ cmd -f "1 2"
• 同じオプションフラグを 2 回以上指定すると,最後に指定したオプションの値が有効になります。
(例)
次のように入力すると,-a 2 が有効となります。
$ cmd -a 1 -a 2
• オプションは,コマンド引数よりも前に指定しなければなりません。
(例)
オプションフラグ a が,フラグ引数をとらない場合,次のように入力すると,file と-b はコマンド 引数とみなされます。
$ cmd -a file -b
• 二つのマイナス記号「− −」は,オプションの終わりを示します。
(例)
次のように入力すると,-b はコマンド引数とみなされます。
$ cmd -a -- -b
• マイナス記号だけのオプションは,入力できません。
(例)
次のように入力すると,「−」はコマンド引数とみなされます。
$ cmd
-(c) コマンド引数
コマンド引数は,ユティリティコマンドの操作で,直接対象になる値を指定します。対象物を修飾指定す る場合,オプションで対象物を指定します。
コマンド引数として制御文ファイルを指定した場合,特に明記しないかぎり通常ファイルを対象とします。