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
-
-
各サーバ単位に定義情報を設定するユーザは，プラグインサーバ環境情報ファイルを作成します。
作成するディレクトリおよびファイル名は次のとおりです。
-
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データ型プラグインの環境定義ファイルの定義例を次の図に示します。
|
|
![[図データ]](GRAPHICS/ZU022400.GIF)
- 注意事項
-
-
各設定項目の行末は改行で区切ってください。
-
設定項目の途中を改行で区切らないでください。
-
1行に設定できる文字列長は1,023バイトです。
-
「#」（シャープ）以降は，コメント文として扱われます。
-
各行は，空行なしで詰めて記述してください。
-
BOM（Byte Order Mark）は使用しないでください。BOMが含まれている場合は，通常の文字として扱います。
-
(2) 設定できる項目
XMLデータ型プラグインを動作させる環境情報をXMLデータ型プラグインの環境定義ファイルに定義することで，ユーザごとの環境を設定できます。設定できる定義項目を次の表に示します。
- 登録・検索同時実行指定，または分割遅延登録・更新系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稼働中に環境情報を変更した場合は，正しく動作しない場合がありますので，変更しないでください。