2.6 XML データ検索プラグインのユーザ環境設定
2.6.1 XML データ型プラグインの環境設定
(1) 環境情報の定義方法
XML データ型プラグインの環境情報を設定するファイルを環境定義ファイルといいます。環境定義ファイ ルは，プラグインごとに作成します。XML データ型プラグインの環境定義ファイルは，サンプルファイル として提供されています。
XML データ型プラグインの環境情報を設定できる単位を次に示します。
• システム単位
システム単位に定義情報を設定するユーザは，プラグインシステム定義情報ファイルを作成します。
作成するディレクトリおよびファイル名は次のとおりです。
• UNIX の場合
$PDDIR/plugin/_phdxml/conf/pdplgsys
• Windows の場合
%PDDIR%\plugin\_phdxml\conf\pdplgsys
• ユニット単位
ユニット単位に定義情報を設定するユーザは，プラグインユニット定義情報ファイルを作成します。
作成するディレクトリおよびファイル名は次のとおりです。
• UNIX の場合
$PDDIR/plugin/_phdxml/conf/pdplgutsys
• Windows の場合
%PDDIR%\plugin\_phdxml\conf\pdplgutsys
• サーバ単位（BES または SDS 単位）
各サーバ単位に定義情報を設定するユーザは，プラグインサーバ環境情報ファイルを作成します。
作成するディレクトリおよびファイル名は次のとおりです。
• HiRDB/パラレルサーバの場合 UNIX の場合
$PDDIR/plugin/_phdxml/conf/BES名称 Windows の場合
%PDDIR%\plugin\_phdxml\conf\BES名称
• HiRDB/シングルサーバの場合 UNIX の場合
$PDDIR/plugin/_phdxml/conf/SDS名称 Windows の場合
%PDDIR%\plugin\_phdxml\conf\SDS名称
優先順位は，サーバ単位＞ユニット単位＞システム単位です。
記述誤りなどが検出された場合，サーバは起動しますが，メッセージログに警告メッセージが出力され，誤 りのある定義ファイルは無視されます。環境定義ファイルがないか，環境定義ファイルはあるが設定されて いない定義がある場合は，エラーではなく，定義値なしとして処理されます。最終的に有効な値がない場合 は，システムのデフォルトで動作します。
メッセージログに次のメッセージが出力されていないことを確認してください。
KFPY99999-I xxxx xxxx(xxxxx) 01001-W Invalid data found.
file=aa,line=XX.bb(YY)
または
KFPY99999-I xxxx xxxx(xxxxx) 01002-W Invalid value found. file=aa,line=XX,item=bb.cc(YY)
XML データ型プラグインの環境定義ファイルの定義例を次の図に示します。
図 2‒29 XML データ型プラグインの環境定義ファイルの定義例
注意事項
• 各設定項目の行末は改行で区切ってください。
• 設定項目の途中を改行で区切らないでください。
• 1 行に設定できる文字列長は 1,023 バイトです。
• 「#」（シャープ）以降は，コメント文として扱われます。
• 各行は，空行なしで詰めて記述してください。
• BOM（Byte Order Mark）は使用しないでください。BOM が含まれている場合は，通常の文字と して扱います。
(2) 設定できる項目
XML データ型プラグインを動作させる環境情報を XML データ型プラグインの環境定義ファイルに定義す ることで，ユーザごとの環境を設定できます。設定できる定義項目を次の表に示します。
表 2‒14 XML データ型プラグインの環境定義ファイルに設定できる定義項目
種別 環境設定項目 パラメタ 設定値 環境設定できる単位
登録・検索同時実 行
登録・検索同時実行指定 set phd_search_wait wait，nowait，また は
nowait_with_upda te
デフォルト：wait
サーバ
エラー処理 エラーコード詳細化指定 set
phd_errorcode_detail
off または on デフォルト：off
システム，ユニット，
サーバ
種別 環境設定項目 パラメタ 設定値 環境設定できる単位 XML データ登録 XMLPARSE 名前空間処理
指定
set
phd_xmlparse_namespa ce
off または on デフォルト：off
システム，ユニット，
サーバ
原文書保持指定 set phd_txt_org Y または N デフォルト：Y
システム，ユニット，
サーバ XQuery 変換式使用時の
原文削除指定
phd_delete_txt_org Y または N デフォルト：N
システム，ユニット，
サーバ 原文なし時 XML 返却指定 phd_serialize_xml Y または N
デフォルト：N
システム，ユニット，
サーバ 登録・検索同時実行指定，または分割遅延登録・更新系 SQL 同時実行指定
登録・検索同時実行，または分割遅延登録・更新系 SQL 同時実行を使用するかどうかを指定します。
なお，この項目を設定できる単位は，サーバ単位だけです。
形式
set phd_search_wait=wait｜nowait｜nowait_with_update
• wait
同時実行を使用しない。
• nowait
登録・検索同時実行を使用する。
• nowait_with_update
登録・検索同時実行機能に加えて，分割遅延登録・更新系 SQL 同時実行を使用する。
エラーコード詳細化指定
SQL 連絡領域にメッセージが返却される場合に，エラーコードを詳細モードで出力するかどうかを指定 します。
詳細モードで出力しない場合，SQLCODE=-997 のエラーとなります。詳細モードで出力する場合，
XML Extension のエラーコードが出力されます。エラーコードの詳細は「付録 F.1 SQL 連絡領域に 出力されるメッセージの形式」を参照してください。
形式
set phd_errorcode_detail=off｜on
• off
詳細化モードで出力しません。
• on
詳細化モードで出力します。
XMLPARSE 名前空間処理指定
XMLPARSE 関数を使用して XML データを登録する場合の名前空間処理方法を指定します。
形式
set phd_xmlparse_namespace=off｜on
• off
名前空間を無効にします。接頭辞が記述されていても，接頭辞が指定されていないものとして処 理し，すべての要素および属性は，規定の XML 名前空間として扱います。
• on
名前空間を有効にします。ただし，名前空間の宣言は開始タグだけを有効とし，DTD での名前 空間の宣言は無視します。なお，XML データ内の各接頭辞は 4096 バイト以内で記述してくだ さい。
注意事項
このパラメタは，環境設定先すべての XML 型列に対して有効となりますので，XMLPARSE 関数で 運用を行う XML 型列が複数ある場合，名前空間の有効／無効を混在できません。また，既存の XML 型列に XMLPARSE 関数でデータが登録されている状態で，このパラメタを変更するだけで は，登録済みのデータ内容は変更できないため，このパラメタを変更した場合は既存の XML 型列の データをすべて再登録する必要があります。旧バージョンの 08-04 ではこのパラメタが off の状態 と同じ仕様となりますので，バージョンアップ後にこのパラメタを on にする場合も XMLPARSE 関数を使用する XML 型列のデータをすべて再登録する必要があります。
なお，名前空間の有効／無効が混在した場合は，検索時の名前空間指定内容が異なりますので，期 待通りの検索結果が得られません。
原文書保持指定
XMLPARSE 関数を使用して XML データを登録する場合，生成する ESIS-B 形式データに原文書を保 持するかどうかを指定します。
形式
set phd_txt_org=Y｜N
• Y
原文書を保持します。
• N
原文書を保持しません。
注意事項
XQuery 変換式では ESIS-B 形式データだけを更新するため，原文と ESIS-B 形式データが異なる XML データになります。XQuery 変換式を利用する場合，ESIS-B 形式データ内に原文書を保持し ない運用を推奨します。
XQuery 変換式使用時の原文削除指定
XQuery 変換式を使用して XML データを更新する場合，更新する ESIS-B 形式データの原文書を削除 するかどうかを指定します。
形式
set phd_delete_txt_org=Y｜N
• Y
原文書を削除します。
• N
原文書を削除しません。
注意事項
XQuery 変換式では ESIS-B 形式データだけを更新するため，原文と ESIS-B 形式データが異なる XML データになります。XQuery 変換式を利用する場合，ESIS-B 形式データ内に原文書を保持し ない運用を推奨します。
原文なし時 XML 返却指定
extracts 関数の第 2 引数に'XML'を指定して，原文を出力する場合に，原文を持たない ESIS-B 形式デー タのときに，ESIS-B 形式データから XML データを再構築して返すか NULL 値を返すかどうかを指定 します。原文を持つ ESIS-B 形式データの場合は，指定に関係なく原文の XML データを返します。
形式
set phd_serialize_xml=Y｜N
• Y
原文を再構築して出力します。
• N
NULL 値を返します。
(3) 有効範囲
環境定義ファイルに定義した環境情報は，サーバ開始から終了まで有効です。HiRDB 稼働中に環境情報を 変更した場合は，正しく動作しない場合がありますので，変更しないでください。