| Oracle® XML Developer's Kitプログラマーズ・ガイド 12c リリース1 (12.1) B71283-04 |
|
 前 |
 次 |
この章では、Extensible Markup Language (XML) SQL Utility (XSU)の使用方法について説明します。
内容は次のとおりです。
XML SQL Utility (XSU)は、Oracle SQL文を介したXMLデータの転送を可能にする、Oracle XML Developer's Kit (XDK)コンポーネントの1つです。XSUを使用して次のタスクを実行できます。
オブジェクト・リレーショナル・データベースの表またはビューのデータをXMLに変換します。XSUは、データベースの問合せを実行し、結果セットをXML文書として戻します。
XML文書からデータを抽出し、正規マッピングを使用して、表またはビューへのデータの挿入、適切な列または属性の値を更新または削除できます。
内容は次のとおりです。
この章では、次のテクノロジを十分に理解していると想定します。
Oracle Database Structured Query Language (SQL)。XSUでは、SELECT文およびデータ操作言語(DML)を介してデータベースとの間でXMLを転送します。
Procedural Language/Structured Query Language (PL/SQL)。XDKには、Java APIをミラー化するXSU用のPL/SQLアプリケーション・プログラミング・インタフェース(API)が用意されています。
Java Database Connectivity (JDBC): XSUを使用してデータベースとの間でXMLの転送を行うJavaアプリケーションには、JDBC接続が必要です。
XSUの主な機能は次のとおりです。
Document Type Definitions (DTD)またはXMLスキーマを動的に生成します。
XML文書を、文書の文字列またはDocument Object Model (DOM)表現で生成します。
生成中、各<ROW>要素のデフォルト・タグ名の変更など、単純な変換を実行します。XSLT変換を登録し、生成したXML文書に対して、必要に応じてその変換を適用できます。
Simple API for XML (SAX2)コールバックのストリームとしてXMLを生成します。
生成中のXML属性をサポートします。この属性のサポートにより、特定の列または列のグループが、XML要素ではなくXML属性にマップされるように指定できます。
SQLからXMLへのタグのエスケープが可能です。列名が有効なXMLタグ名ではない場合があります。この問題を回避するには、すべての列名に別名を付けるか、またはタグをエスケープします。
オブジェクトまたは表内のXMLType列をサポートします。
リレーショナル・データベースの表またはビューにXMLを挿入します。XML文書を指定すると、XSUはデータベース・オブジェクトのレコードを更新または削除できます。
XSUを使用する場合は、次の制限に注意してください。
XSUは、単一表にのみデータを格納できます。ただし、Oracle Extensible Stylesheet Language Transformation (XSLT)プロセッサを使用して文書を複数の文書に変換して個別に挿入することで、複数の表にまたがってXMLを格納できます。また、複数表にまたがるビューを定義し、ビューへの挿入を行うこともできます。このビューが更新不可能(複雑な結合などのために)な場合は、ビューにまたがってINSTEAD OFトリガーを使用して、挿入を実行できます。
属性に格納されたXMLデータはXSUを使用してデータベース・スキーマにロードできませんが、XSLT変換を使用して属性を要素に変更することは可能です。
デフォルトでは、XSUには大/小文字の区別があります。正確な大/小文字を使用するか、大/小文字の区別を無視するように指定できます。
XSUは、入力DTDからリレーショナル・データベース・スキーマを生成できません。
XSUを使用したXMLType表への挿入はサポートされていません。XMLType列はサポートされています。
内容は次のとおりです。
次のインタフェースからXSUにアクセスできます。
oracle.xml.sql.queryパッケージのOracleXMLQueryおよびOracleXMLSave Javaクラス: OracleXMLQueryクラスを使用してリレーショナル・データからXMLを生成し、OracleXMLSaveクラスを使用してDMLを実行します。
PL/SQLパッケージDBMS_XMLQueryおよびDBMS_XMLSave: Javaクラスをミラー化します。
次のようなタイプのXSUアプリケーションを作成できます。
データベース内で実行して内部XSU Java APIにアクセスするJavaプログラム
クライアントで実行してクライアント側XSU Java APIにアクセスするJavaプログラム
PL/SQLパッケージを介してXSUにアクセスするPL/SQLプログラム
OracleXMLSaveクラスを使用して、データベースのXMLを挿入、更新および削除します。図13-2に、基本プロセスを示します。
図13-2の基本手順は次のとおりです。
データベースへのJDBC接続を作成します。この手順は、「XSUのJava APIを使用したXMLの生成: 基本プロセス」で説明している最初の手順と同じです。
XML保存オブジェクトを作成し、DMLを実行するための表を割り当てます。コンストラクタに表名またはビュー名を渡します。次に例を示します。
OracleXMLSave sav = new OracleXMLSave(conn, "employees");
主キー列を指定します。たとえば、次のコードは、employee_idがキー列であることを指定します。
String [] keyColNames = new String[1]; keyColNames[0] = "EMPLOYEE_ID"; sav.setKeyColumnList(keyColNames);
OracleXMLSaveのメソッドを起動して、XML保存オブジェクトを構成します。次の例は、salaryおよびjob_id列の更新を指定します。
String[] updateColNames = new String[2]; updateColNames[0] = "SALARY"; updateColNames[1] = "JOB_ID"; sav.setUpdateColumnList(updateColNames); // set the columns to update
OracleXMLSaveオブジェクトに対してinsertXML()、updateXML()またはdeleteXML()メソッドを起動します。次の例では、更新を示します。
// Assume that the user passes in this XML document as the first argument sav.updateXML(sav.getURL(argv[0]));
DMLの実行中に、XSUは次のタスクを行います。
入力XML文書を解析します。
要素名をターゲットの表またはビューにある列名と照合します。
要素をSQL型に変換し、適切な文にバインドします。
OracleXMLSaveオブジェクトをクローズし、関連するすべてのコンテキストを割当て解除します。次に例を示します。
sav.close();
関連項目:
JDBCの詳細は、『Oracle Database Java開発者ガイド』を参照してください。
OracleXMLSaveのメソッドの詳細は、Oracle Database XML Java APIリファレンスを参照してください
XSUのPL/SQL APIは、XML文書の生成およびデータベースへの格納の方法がJava APIに似ています。DBMS_XMLQueryは、OracleXMLQuery Javaクラスのメソッドが反映されたPL/SQLパッケージです。このパッケージには、パッケージに対応付けられたコンテキスト・ハンドルがあります。コンストラクタに類似したファンクションを起動してコンテキストを作成し、ハンドルを取得してそのハンドルをすべての副問合せの起動に使用します。
注意:
パフォーマンス向上のため、DBMS_XMLQUERYではなく、Cで記述されデータベースに組み込まれたCベースのDBMS_XMLGENの使用を検討してください。
XSUは、XMLTypeデータ型をサポートします。XSUでのXMLTypeの使用は、オブジェクトまたは表内にXMLType列が含まれる場合などに有効です。
XMLを生成すると、XML文書を含むキャラクタ・ラージ・オブジェクト(CLOB)が生成されます。DBMS_XMLQueryおよびXSU生成エンジンを使用するための基本手順は次のとおりです。
DBMS_XMLSaveは、OracleXMLSave Javaクラスのメソッドが反映されたPL/SQLパッケージです。このパッケージには、パッケージに対応付けられたコンテキスト・ハンドルがあります。コンストラクタに類似したファンクションを起動してコンテキストを作成し、ハンドルを取得してそのハンドルをすべての副問合せの起動に使用します。
DBMS_XMLSaveを使用するための基本手順は次のとおりです。
「XSUのJava APIを使用したプログラミング」に示したJavaの例をモデルとして使用してください。
XSUは、他のXDKユーティリティとともにOracle Databaseの一部として含まれています。XSUのコンポーネントおよび依存性の説明は、「XDK for Javaコンポーネントの依存性」に記載されています。
デフォルトでは、Oracle Universal Installerによって、XSUがディスク上にインストールされ、データベースにロードされます。ユーザーが操作する必要はありません。OracleをインストールしたときにXSUをデータベースにロードしなかった場合は、次のようにXSUを手動でインストールできます。
xsu12.jarファイルをデータベースにロードします。このJARファイルには、XMLTypeへのアクセスに関してxdb.jarへの依存性があります。JARファイルの詳細は、表3-1を参照してください。$ORACLE_HOME/rdbms/admin/dbmsxsu.sqlスクリプトを実行します。このSQLスクリプトは、XSUのPL/SQL APIを構築します。「XSUの使用: 基本プロセス」で説明しているように、XSUを使用するために、XSUをデータベースにロードする必要はありません。XSUは、Javaをサポートする任意の層に格納できます。
次の項では、インストール・オプションについて説明します。
図13-3に、データベースにインストールされたXSUライブラリを使用するアプリケーションの一般的なアーキテクチャを示します。データベース内で実行するXSUが生成したXMLは、データベースのアドバンスト・キュー内に置いて、他のシステムまたはクライアントにキューさせることができます。XMLは、データベース内のストアド・プロシージャを介して内部に配信するか、Webサーバーまたはアプリケーション・サーバーを通じて外部に配信します。
図13-3では、すべての矢印が両方向です。XSUでは、データを生成および保存できるため、データベース内で実行しているXSUにXMLを配信し、それを適切なデータベース表に挿入できます。
アプリケーション・アーキテクチャによっては、中間層のアプリケーション・サーバーが必要な場合もあります。アプリケーション層には、Javaプログラムをサポートするデータベースまたはアプリケーション・サーバーを指定できます。
様々な理由のために(たとえば、中間層で異なるJDBCデータ・ソースを統合するために)、中間層でSQL問合せまたはResultSetsからXMLを生成できます。この場合、中間層にXSUをインストールすると、JavaプログラムでJava APIを介してXSUを使用できます。
図13-4に、中間層でXSUを実行するための一般的なアーキテクチャを示します。中間層で、JDBCソースのデータはXSUによってXMLに変換され、Webサーバーまたは他のシステムに送信されます。ここでもプロセスは両方向であるため、XSUを使用してデータを元のJDBCソース(データベース表またはビュー)に戻すことができます。データベースをアプリケーション・サーバーとして使用する場合は、JavaのかわりにPL/SQLのフロントエンドを使用できます。
図13-5に示すように、WebサーバーがJavaサーブレットをサポートするため、XSUをWebサーバー内で実行できます。この場合、XSUを使用するJavaサーブレットを作成できます。XSQLサーブレットは、Oracleが提供する標準のサーブレットです。これはXSUの最上位に構築され、XSUの機能へのテンプレート形式のインタフェースを提供します。WebサーバーでXML処理を実行し、サーブレットの複雑なプログラミングを避けるために、XSQLサーブレットを使用できます。
関連項目:
XMLTypeが含まれているXSUの使用例については、『Oracle XML DB開発者ガイド』の特にXMLの生成に関する章を参照してください。
OracleXMLQueryおよびOracleXMLSaveクラスの詳細は、Oracle Database XML Java APIリファレンスを参照してください
DBMS_XMLQueryパッケージの詳細は、『Oracle Database PL/SQLパッケージ・プロシージャおよびタイプ・リファレンス』を参照してください。
DBMS_XMLSaveパッケージの詳細は、『Oracle Database PL/SQLパッケージ・プロシージャおよびタイプ・リファレンス』を参照してください。
XSQLサーブレットの詳細は、「XSQLページ・パブリッシング・フレームワークの使用」を参照してください
XSUのデモ・プログラムは、$ORACLE_HOME/xdk/demo/java/xsuにあります。表13-1に、XSUのテストに使用できるXMLファイルとプログラムを示します。
表13-1 XSUのサンプル・ファイル
| ファイル | 説明 |
|---|---|
|
|
|
|
|
オブジェクト・リレーショナル・スキーマを設定し、データを移入するSQLスクリプト。「オブジェクト・リレーショナル・スキーマでのXMLのマッピング」を参照してください。 |
|
オブジェクト・リレーショナル・スキーマを設定し、データを移入するSQLスクリプト。「データベース・スキーマまたはSQL問合せの変更」を参照してください。 |
|
リレーショナル表を作成し、最上位にカスタマ・オブジェクトを持つカスタマ・ビューを作成するSQLスクリプト。「データベース・スキーマまたはSQL問合せの変更」を参照してください。 |
|
カスタマについて記述されたXML文書。「データベース・スキーマまたはSQL問合せの変更」を参照してください。 |
|
主キーで従業員を削除するPL/SQLプログラム。「DBMS_XMLSaveを使用したキーによる削除: 例」を参照してください。 |
|
行で従業員を削除するPL/SQLプログラム。「DBMS_XMLSaveを使用した行による削除: 例」を参照してください。 |
|
DOMツリーを生成し、ドキュメント内の順序でツリーを検索して、ノードを1つずつ出力するプログラム。「OracleXMLQueryを使用したDOMツリーの生成」を参照してください。 |
|
デモ・ディレクトリのプログラムについて説明するREADME。 |
|
XML文書を表に挿入するPL/SQLプログラム。「DBMS_XMLSaveを使用したすべての列への値の挿入」を参照してください。 |
|
|
|
XML文書を |
|
XML文書を |
|
XML文書を |
|
|
|
|
|
|
|
新しい従業員を記述したXML文書。「testInsertプログラムの実行」を参照してください。 |
|
新しい従業員を記述したXML文書。「testInsertSubsetプログラムの実行」を参照してください。 |
|
行がなくなると、例外を発生させるプログラム。「該当する行がない場合の例外の生成」を参照してください。 |
|
JDBCの |
|
結果ページを区切るXMLページを生成するプログラム。「OracleXMLQueryを使用した結果ページの区切り: 例」を参照してください。 |
|
結果ページを区切り形式にするPL/SQLスクリプト。最初の10行のバッチで |
|
CLOBを出力バッファへ出力するPL/SQLスクリプト。「DBMS_XMLQueryを使用した単純な問合せからのXMLの生成」を参照してください。 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
同じコンテキストおよび設定を使用して、ユーザーの入力に基づいてDMLを実行するPL/SQLスクリプト。「DBMS_XMLSaveを使用したコンテキスト・ハンドルの再利用」を参照してください。 |
|
行の識別のために使用される要素の数を制限し、 |
|
入力XML文書のすべての |
|
XML文書のファイル名を入力として受け入れ、文書内の要素に対応する行を削除するプログラム。「OracelXMLSaveを使用した行による削除」を参照してください。 |
|
入力XML文書のすべての |
|
ランタイム例外をスローし、 |
|
|
|
XMLデータを列のサブセットに挿入するPL/SQLスクリプト。「DBMS_XMLSaveを使用した列のサブセットへの挿入」を参照してください。 |
|
XMLデータを列のサブセットに挿入するプログラム。「OracleXMLSaveを使用した列のサブセットへのXMLの挿入」を参照してください。 |
|
REFカーソルを定義し、そのカーソルを戻すファンクションを作成するPL/SQLスクリプト。 |
|
|
|
|
|
各従業員の給与および役職名のみを更新し、他の情報を無視するとします。XML文書内のすべての |
|
プロシージャ |
|
XSUを使用して、XMLを |
|
一連の従業員の更新された給与およびその他の情報を含むXML文書。「testUpdateプログラムの実行」を参照してください。 |
|
一連の従業員の更新された給与およびその他の情報を含むXML文書。「testUpdateプログラムの実行」を参照してください。 |
|
2人の従業員の新規データを含むXML文書。「testUpdateListプログラムの実行」を参照してください。 |
|
|
デモの実行手順は次のとおりです。
次の項では、XSUのデモについて詳しく説明します。
XDKには、XSUのためのコマンドラインJavaインタフェースがあります。XSUのコマンドライン・オプションは、JavaクラスOracleXMLを介して利用できます。このAPIを使用するには、「XDK for Java環境の設定」の説明に従ってJavaクラスパスが設定されていることを確認します。
XSUの使用情報を標準出力に出力するには、次のコマンドを実行します。
java OracleXML
XSUを使用するには、次のようにgetXMLまたはputXMLのいずれかのパラメータを使用して起動します。
java OracleXML getXMLoptionsjava OracleXML putXMLoptions
表13-2に、getXMLオプションを示します。
表13-2 getXMLオプション
| getXMLオプション | 説明 |
|---|---|
|
データベースに接続するためのユーザー名およびパスワードを指定します。接続文字列も指定されます。ユーザー名およびパスワードを接続文字列の一部として指定できます。 |
|
JDBCデータベースの接続文字列を指定します。デフォルトの接続文字列は" |
|
XML文書とともにDTDも生成するようにXSUに指示します。 |
|
XML文書とともにスキーマも生成するようにXSUに指示します。 |
|
ROWSETタグを指定し、問合せによって戻されたレコードに対応するすべてのXML要素を囲みます。デフォルトのROWSETタグは、 |
|
ROWタグを指定し、データベース行に対応するデータを囲みます。デフォルトのROWタグは |
|
|
- |
問合せからのスカラー列の値が、 |
|
XMLリスト要素の属性に名前を付け、リストの要素の数を追跡します。生成されるXMLリストは、カーソル問合せまたはコレクションのいずれかに対応します。 |
|
column-elementタグに使用する型名を指定します。デフォルトでは、XSUは |
|
属性 |
|
XML処理命令にスタイルシートを指定します。 |
|
XML処理命令にスタイルシートの型を指定します。 |
|
XML文書に適用するXSLTスタイルシートを指定します。 |
|
XSLT外部実体参照を設定します。 |
|
小文字または大文字のタグ名を生成します。デフォルトでは、大/小文字は、タグ名の生成元のSQLオブジェクト名に一致します。 |
|
SQLオブジェクト名では有効であっても、XMLタグでは無効な文字の対処方法を指定します。このような文字を検出した場合は、エスケープして例外を発生させません。 |
|
XMLにフォーマットされたエラー・メッセージを囲むタグを指定します。 |
|
XSUがJava例外を発生させることを指定します。デフォルトでは、XSUがエラーを捕捉し、XMLエラーを発行します。 |
|
行が戻されなかった場合に例外を発生させます。 |
|
入力データに対して厳密なチェックを行います。 |
|
XMLに変換するために取得される行の最大数を指定します。 |
|
スキップされる行の数を指定します。 |
|
生成されるXMLのキャラクタ・セットのエンコーディングを指定します。 |
|
XML文書内の日付値用の書式を指定します。 |
|
問合せを含むファイル名または問合せ自体を指定します。 |
表13-3に、putXMLオプションを示します。
表13-3 putXMLオプション
| putXMLオプション | 説明 |
|---|---|
|
データベースに接続するためのユーザー名およびパスワードを指定します。接続文字列も指定されます。ユーザー名およびパスワードを接続文字列の一部として指定できます。 |
|
JDBCデータベースの接続文字列を指定します。デフォルトの接続文字列は" |
|
バッチ・サイズを指定します。これによって、バッチされ、一度にデータベースに挿入される行の数を制御し、パフォーマンスを改善できます。 |
|
コミットが実行される挿入レコードの数を指定します。自動コミットを |
|
|
|
XML文書内の日付値用の書式を指定します。 |
|
文書の生成時にSQLからXMLへの名前のエスケープを使用すると、逆マッピングが有効になります。 |
|
列名とタグ名を大/小文字を区別せずに一致させます。たとえば、 |
|
挿入されるXML文書内の空白を保持します。 |
|
挿入前にXML文書に適用するXSLTを指定します。 |
|
XSLT外部実体参照を設定します。 |
|
挿入するXML文書を指定します。ローカル・ファイル、URLまたはXML文書をコマンドライン上の文字列として指定します。 |
|
値を挿入する表の名前を指定します。 |
データベース・スキーマからXMLを生成するには、getXMLパラメータを使用します。たとえば、hrスキーマにあるemployees表に問合せを行ってXML文書を生成するには、次の構文を使用できます。
java OracleXML getXML -user "hr/password" "SELECT * FROM employees"
前述のコマンドによって次のタスクが実行されます。
SELECT問合せの実行getXMLパラメータは、表13-2に示した広範囲なオプションをサポートします。
XSUを使用して、XMLType列を持つ表からXMLを生成できます。デモ・スクリプトsetup_xmltype.sqlを実行してparts表を作成し、表にデータを挿入するとします。XSUを使用してこの表からXMLを生成できます。
java OracleXML getXML -user "hr/password" -rowTag "Part" "SELECT * FROM parts"
次にコマンドの出力を示します。
<?xml version = '1.0'?>
<ROWSET>
<Part num="1">
<PARTNO>1735</PARTNO>
<PARTNAME>Gizmo</PARTNAME>
<PARTDESC>
<Description>
<Title>Description of the Gizmo</Title>
<Author>John Smith</Author>
<Body>
The <b>Gizmo</b> is <i>grand</i>.
</Body>
</Description>
</PARTDESC>
</Part>
</ROWSET>
new_employees.xmlというXML文書をhr.employees表に挿入するには、次の構文を使用します。
java OracleXML putXML -user "hr/password" -fileName "new_employees.xml" employees
前述のコマンドによって次のタスクが実行されます。
hrとして現在のデータベースに接続new_emp.xmlというXML文書の読取りemployees表への値の適切な挿入getXMLパラメータは、表13-2に示した広範囲なオプションをサポートします。
内容は次のとおりです。
testXMLSQL.javaデモ・プログラムは、XSUを使用してXMLをStringオブジェクトとして生成します。このプログラムはhr.employees表に問合せを行って結果セットを標準出力に出力します。
testXMLSQL.javaプログラムは次の手順を実行します。
次の手順に従って、testXMLSQL.javaプログラムを実行します。
javacを使用してtestXMLSQL.javaをコンパイルします。java testXMLSQLを実行します。Java実行可能ファイルがクラスを検索できるように、CLASSPATHがこのディレクトリを指すようにする必要があります。このプログラムのコンパイルおよび実行には、OracleのJDeveloperなどのビジュアルなJavaツールも使用できます。このプログラムを実行すると、画面にXMLファイルが出力されます。次のコードは、いくつかの行が編集されているサンプル出力を示します。
<?xml version = '1.0'?>
<ROWSET>
<ROW num="1">
<EMPLOYEE_ID>100</EMPLOYEE_ID>
<FIRST_NAME>Steven</FIRST_NAME>
<LAST_NAME>King</LAST_NAME>
<EMAIL>SKING</EMAIL>
<PHONE_NUMBER>515.123.4567</PHONE_NUMBER>
<HIRE_DATE>6/17/1987 0:0:0</HIRE_DATE>
<JOB_ID>AD_PRES</JOB_ID>
<SALARY>24000</SALARY>
<DEPARTMENT_ID>90</DEPARTMENT_ID>
</ROW>
<!-- ROW num="2" through num="107" ... -->
</ROWSET>
XSUが生成したXMLからDOMツリーを生成するには、XSUにDOM文書を直接リクエストします。この方法は、XML文書の文字列表現を作成するオーバーヘッドを伴わずに、XML文書を解析してDOMツリーを生成します。
XSUは、Oracle XML Parserを起動してデータ値からDOMツリーを構築します。domTest.javaデモ・プログラムは、DOMツリーを生成し、ドキュメント内の順序でツリーを検索して、ノードを1つずつ出力します。
domTest.javaプログラムの最初の2つの手順は、「OracleXMLQueryを使用した文字列の生成」のtestXMLSQL.javaプログラムと同じです。プログラムは次のように続行します。
プログラムをコンパイルした後、次のようにコマンドラインから実行します。
java domTest
testXMLSQL.javaおよびdomTest.javaで、XSUは問合せによって戻されたすべての行からXMLを生成しました。一度に100行のみ必要であるとき、1000行を含む表に問合せを行う場合を考えます。これには、1つの問合せを実行して最初の100行を取得し、別の問合せによって次の100行を取得し、100行ずつ取得していく方法があります。この方法では、問合せの最初の5行をスキップして結果を生成することはできません。この問題を回避するには、次のJavaメソッドを使用します。
OracleXMLSave.setSkipRows()を使用すると、必要な行数を強制的にスキップして結果を生成できます。このメソッドと同等の効果を持つコマンドラインは、-skipRowsパラメータです。
OracleXMLSave.setMaxRows()を使用すると、XMLに変換される行数を制限できます。このメソッドと同等の効果を持つコマンドラインは、-maxRowsパラメータです。
例13-1では、skipRowsの値を5に設定し、maxRowsの値を1に設定します。これによって、hr.employees表に問合せを行うと、XSUは最初の5行をスキップしてから次の行のXMLを生成します。
次にサンプル出力を示します(問合せ結果セットの6行目のみが戻されます)。
<?xml version = '1.0'?>
<ROWSET>
<ROW num="6">
<EMPLOYEE_ID>105</EMPLOYEE_ID>
<FIRST_NAME>David</FIRST_NAME>
<LAST_NAME>Austin</LAST_NAME>
<EMAIL>DAUSTIN</EMAIL>
<PHONE_NUMBER>590.423.4569</PHONE_NUMBER>
<HIRE_DATE>6/25/1997 0:0:0</HIRE_DATE>
<JOB_ID>IT_PROG</JOB_ID>
<SALARY>4800</SALARY>
<MANAGER_ID>103</MANAGER_ID>
<DEPARTMENT_ID>60</DEPARTMENT_ID>
</ROW>
</ROWSET>
例13-1 コマンドラインでのskipRowsおよびmaxRowsの指定
java OracleXML getXML -user "hr/password" -skipRows 5 -maxRows 1 \
"SELECT * FROM employees"
状況によっては、問合せオブジェクトをユーザーのセッション中オープンにしておくことが必要な場合があります。maxRows()メソッドおよびkeepObjectOpen()メソッドを使用すると、このような状況に対処できます。
検索の結果をページ区切りの形式にするWeb検索エンジンについて考えてみます。これらのエンジンでは、最初のページに10個の結果、次のページに次の10個のように結果が表示されます。XSUでこのタスクを実行するには、一度に10行ずつリクエストし、ResultSetをオープン状態にしておきます。こうするとXSUは、次に追加の結果をリクエストされたときに、前回の生成が終了した箇所から生成を開始します。OracleXMLQueryでは、SQL問合せ文字列から結果セットを作成すると、それ以上の結果が必要でないと想定して、通常ではResultSetを内部的にクローズします。したがって、keepObjectOpen()を起動してカーソルをアクティブにしておく必要があります。
行数または行内の列数が多すぎる場合もオープンな問合せオブジェクトが必要になります。この場合は、1つの大きな文書を生成するのではなく、複数の小さな文書を生成できます。
問合せを実行して、結果セットの中から、前のページの結果を取得することが必要になる場合があります。スクロールを使用可能にするには、Oracle.jdbc.ResultSetクラスをインスタンス化します。このスクロール可能なResultSetオブジェクトを使用して結果セット内を移動し、移動するたびにXSUを使用してXMLを生成できます。
pageTest.javaプログラムは、JDBCのResultSetを使用して一度に1ページずつXMLを生成する方法を示します。ResultSetは、バッチ・サイズの設定や値のバインドなど、XSUで直接処理されない操作のときに使用する必要があります。
pageTest.javaプログラムは、pageTestオブジェクトを作成し、SQL問合せを使用して初期化します。pageTestオブジェクトのコンストラクタは、次の手順を実行します。
プログラムをコンパイルした後、次のようにコマンドラインから実行します。
java pageTest
OracleXMLQueryクラスは、問合せ文字列またはResultSetオブジェクトに対してのみXML変換を行います。プログラムがPL/SQLプロシージャを使用し、このプロシージャがREFカーソルを戻す場合の変換方法を考えてみます。この場合は、「スクロール可能な結果セットの生成」で説明したResultSet変換メカニズムを使用できます。
REFカーソルは、PL/SQL内のカーソル・オブジェクトへの参照です。これらのカーソル・オブジェクトは、一連の値を取得するためにプログラムで繰り返し処理されるSQL文です。これらのカーソル・オブジェクトは、JavaではOracleResultSetオブジェクトに変換されます。Javaプログラムで、CallableStatementオブジェクトを初期化し、カーソル変数を戻すPL/SQLファンクションを実行し、OracleResultSetオブジェクトを取得したら、それをOracleXMLQueryオブジェクトに送信して必要なXMLを取得できます。
testRef.sqlスクリプトで定義されたtestRef PL/SQLパッケージについて考えてみます。これは、REFカーソルを定義するファンクションを作成して戻します。testRefCur PL/SQLファンクションは、コールされるたびにSELECT問合せに対してカーソル・オブジェクトをオープンし、そのカーソル・インスタンスを戻します。オブジェクトをXMLに変換するには、次のようにします。
testRef.sqlスクリプトを実行してhrスキーマ内にtestRefパッケージを作成します。refCurTest.javaプログラムをコンパイルおよび実行し、testRefCurファンクションに定義されたSQL問合せの結果からXMLを生成します。スタイルシートを適用するには、applyStylesheetコマンドを使用して、出力を生成する前にスタイルシートを強制的に適用します。
表またはビューに文書を挿入するには、表名またはビュー名と文書を指定します。XSUは文書(文字列が指定されている場合)を解析し、INSERT文を作成してこの文にすべての値をバインドします。デフォルトでは、XSUは値を表またはビューのすべての列に挿入します。存在しない要素は、NULL値として処理されます。次の例では、hr.employees表から生成したXML文書を表に格納する方法を示します。
testInsert.javaデモ・プログラムは、hr.employees表のすべての列にXML値を挿入します。
プログラムは次の手順を実行します。
従業員IDが7369の新しい従業員Janet Smithについてnew_emp.xml文書を作成する場合を考えます。次のように、ファイル名new_emp.xmlを引数としてtestInsertプログラムに渡します。
java testInsert "new_emp.xml"
指定した列の値を含む新しい行がemployees表に挿入されます。行要素内に存在しない要素は、NULLとして扱われます。
プログラムを実行すると、次の形式のINSERT文が生成されます。
INSERT INTO hr.employees (employee_id, first_name, last_name, email, phone_number, hire_date, salary, commission_pct, manager_id, department_id) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);
XSUによって、列名と一致している入力XML文書内の要素タグが照合され、その値がバインドされます。
値を挿入する必要がない列がある場合もあります。たとえば、取得する値が完全なセットではなく、残りの列のためにトリガーまたはデフォルト値を使用する必要がある場合などです。testInsertSubset.javaデモ・プログラムは、その処理の方法を示します。
プログラムは次の手順を実行します。
new_emp2.xml文書を使用して、従業員IDが7400の新しい従業員Adamsのデータを格納する場合を考えます。次のように、new_emp2.xmlを引数としてtestInsertプログラムに渡します。
java testInsert new_emp2.xml
入力ファイルに指定されていない列の値は、無視されます。入力に含まれる各ROW要素のINSERTが実行され、INSERT文はデフォルトでバッチ処理されます。
このプログラムで生成されるINSERT文は次のとおりです。
INSERT INTO hr.employees (employee_id, last_name, email, job_id, hire_date) VALUES (?, ?, ?, ?, ?);
表名またはビュー名、およびXML文書を指定して、表またはビューのフィールドを更新します。XSUは文書(文字列が指定されている場合)を解析し、1つ以上のUPDATE文を作成してこの文にすべての値をバインドします。次の例に、XML文書を使用してhr.employees表を更新する方法を示します。
testUpdate.javaデモ・プログラムは、OracleXMLSave.setKeyColumnList()メソッドを起動してhr.employees表を更新します。
testUpdate.javaプログラムは次の手順を実行します。
XSUを使用して、表内の指定したフィールドを更新できます。例13-2のupd_emp.xmlには、追加した2人の従業員、7369および7400の更新済の給与およびその他の情報が含まれます。
更新の場合は、UPDATE文のWHERE句に、キー列の名前のリストを指定します。hr.employees表では、employee_id列がキーです。
次のように、前述のプログラムにファイル名upd_emp.xmlを引数として渡します。
java testUpdate upd_emp.xml
このプログラムは、2つのUPDATE文を生成します。最初のROW要素には、SALARYフィールドを更新するためのUPDATE文が次のように生成されます。
UPDATE hr.employees SET salary = 3250 WHERE employee_id = 7400;
2番目のROW要素には、次の文が生成されます。
UPDATE hr.employees SET job_id = 'SA_REP' AND MANAGER_ID = 145 WHERE employee_id = 7369;
例13-2 upd_emp.xml
<?xml version='1.0'?>
<ROWSET>
<ROW num="1">
<EMPLOYEE_ID>7400</EMPLOYEE_ID>
<SALARY>3250</SALARY>
</ROW>
<ROW num="2">
<EMPLOYEE_ID>7369</EMPLOYEE_ID>
<JOB_ID>SA_REP</JOB_ID>
<MANAGER_ID>145</MANAGER_ID>
</ROW>
<!-- additional rows ... -->
</ROWSET>
XML文書内の要素のサブセットのみを使用して、表を更新する場合もあります。このような更新を実行するには、列のリストを指定できます。XSUはすべてのROW要素に対してバインド変数を持つ同じUPDATE文を使用するため、列リストを指定すると処理速度が向上します。また、XML文書内にある他のタグを無視できます。
注意:
更新する列のリストを指定すると、更新する列に対応する要素が存在しない場合は、その要素がNULLとして処理されます。
各従業員の給与および役職名を更新し、他のデータを無視するとします。XML文書内のすべてのROW要素について、更新対象の要素がすべて同じである場合は、OracleXMLSave.setUpdateColumnNames()メソッドを使用して列を指定できます。testUpdateList.javaプログラムではこの方法を示します。
testUpdateList.javaプログラムは次の手順を実行します。
サンプルXML文書upd_emp2.xmlを使用して、従業員IDが100のSteven Kingおよび従業員識別子(ID)が206のWilliam Gietzの新しいデータを格納する場合を考えます。次のように、upd_emp2.xmlを引数としてtestUpdateListプログラムに渡します。
java testUpdateList upd_emp2.xml
この例では、プログラムが2つのUPDATE文を生成します。最初のROW要素には、次の文が生成されます。
UPDATE hr.employees SET salary = 8350 AND job_id = 'AC_ACCOUNT' WHERE employee_id = 100;
2番目のROW要素には、次の文が生成されます。
UPDATE hr.employees SET salary = 25000 AND job_id = 'AD_PRES' WHERE employee_id = 206;
XML文書からの削除の場合は、キー列のリストを指定できます。これらの列は、DELETE文のWHERE句で使用されます。キー列名を指定しないと、XML文書の各ROW要素に対して新しいDELETE文が作成されます。DELETE文のWHERE句にある列のリストと、ROW要素にある列は一致します。
testDeleteRow.javaデモ・プログラムは、XML文書のファイル名を入力として受け入れ、文書内の要素に対応する行を削除します。
testDeleteRow.javaプログラムは次の手順を実行します。
この項では、「OracleXMLSaveを使用した行の挿入」で追加した従業員7400および7369を削除する方法を示します。
この例を正しく実行するには、データベースに接続し、hr.job_history表に対する制約を無効にします。
CONNECT hr ALTER TABLE job_history DISABLE CONSTRAINT JHIST_EMP_FK; EXIT
次のように、testDeleteRowプログラムにupd_emp.xmlを渡します。
java testDeleteRow upd_emp.xml
XML文書内の各ROW要素にあるタグ名に基づいて、DELETE文が構成されます。次の文が実行されます。
DELETE FROM hr.employees WHERE salary = 3250 AND employee_id = 7400; DELETE FROM hr.employees WHERE job_id = 'SA_REP' AND MANAGER_ID = 145 AND employee_id = 7369;
DELETE文の述語としてキー値のみを使用する場合は、OracleXMLSave.setKeyColumnList()メソッドを起動します。行の識別に使用する要素の数を制限するこの方法には、DELETE文をキャッシュし、トランザクションをバッチ化することによるパフォーマンス向上という利点があります。testDeleteKey.javaプログラムではこの方法を示します。
testDeleteKey.javaプログラムは次の手順を実行します。
この項では、「OracleXMLSaveを使用したキー列の更新」で追加した従業員7400および7369を削除する方法を示します。前述の例でこれらの従業員が削除されている場合は、これらの従業員を元のemployees表に追加できます。
java testInsert new_emp.xml java testInsert new_emp2.xml
testDeleteRowプログラムに同じupd_emp.xml文書を渡して、従業員7400および7369を削除します。
java testDeleteKey upd_emp.xml
次の単一のDELETE文が生成されます。
DELETE FROM hr.employees WHERE employee_id=?;
次のDELETE文が、それぞれ各従業員に対して実行されます。
DELETE FROM hr.employees WHERE employee_id = 7400; DELETE FROM hr.employees WHERE employee_id = 7369;
XSUは、処理中に発生したすべての例外を捕捉し、一般的なランタイム例外であるoracle.xml.sql.OracleXMLSQLExceptionをスローします。適切な処置を実行できる場合は、起動するプログラムはこの例外を捕捉する必要がありません。例外クラスには、エラー・メッセージおよび存在する場合は親である例外も取得するためのメソッドがあります。
testException.javaデモ・プログラムは、ランタイム例外をスローし、Exception.getParentException()を起動して親である例外を取得します。
前述のプログラムを実行すると、次のエラー・メッセージが生成されます。
Caught SQL Exception:ORA-00904: "SD": invalid identifier
XSUは、処理する行がない場合はNULL文字列を戻します。ただし、プログラムが例外ハンドラを使用して例外を処理できるように、行がなくなるたびに例外を発生させることができます。OracleXMLQuery.setRaiseNoRowsException()を起動すると、XSUは、出力用に生成する行がなくなるたびに、oracle.xml.sql.OracleXMLSQLNoRowsExceptionを発生させます。これはランタイムの例外であり、捕捉する必要はありません。
noRowsTest.javaデモ・プログラムは、pageTest.javaに定義されたpageTestクラスをインスタンス化します。終了を確認する条件が、結果がnullかどうかの確認から、例外ハンドラに変更されました。
noRowsTest.javaプログラムは、pageTestオブジェクトを作成し、SQL問合せを使用して初期化します。プログラムは次のように続行します。
プログラムをコンパイルした後、次のようにコマンドラインから実行します。
java noRowsTest
内容は次のとおりです。
注意:
パフォーマンス向上のため、DBMS_XMLQueryおよびDBMS_XMLSaveのかわりに、DBMS_XMLGenおよびDBMS_XMLStoreの使用を検討してください。前者の2つのパッケージはCで記述され、データベース・カーネルに組み込まれています。XMLElementなどのSQL/XML関数を使用して、データベースのXMLにアクセスすることもできます。
この項では、DBMS_XMLQueryパッケージを使用してSQL問合せからXMLを生成する方法を示します。この例を実行するには、hrとしてデータベースに接続し、printClobOut.sqlスクリプトを実行します。このスクリプトは、CLOBを出力バッファに出力する単純なプロシージャprintClobOutを作成します。SQL*PlusでprintClobOutプロシージャを実行すると、入力CLOBが画面に出力されます。結果を表示するには、サーバーの出力をONに設定します。表示バッファを増やして全出力を表示する必要がある場合があります。
simpleQuery.sqlスクリプトを実行して、hr.employees表から20行選択し、XML文書をCLOBとして取得します。プログラムは、最初に問合せを渡してコンテキスト・ハンドルを取得し、次にgetXMLファンクションを起動してCLOB値を取得します。文書のエンコーディングは、データベース・キャラクタ・セットのエンコーディングと同じになります。このサンプル・アプリケーションでは、printClobOut.sqlを実行してprintClobOutプロシージャが作成されていることが前提になっています。
XSUのPL/SQL APIを使用して、デフォルトのROWおよびROWSET要素名を変更できます。これらはデフォルトの名前であり、結果の各行の先頭と末尾、および出力XML文書全体の先頭と末尾にそれぞれ置かれます。このタスクを実行するには、PL/SQLプロシージャsetRowTagNameおよびsetRowSetTagNameを使用します。
hrとして接続し、SQL*PlusでchangeElementName.sqlスクリプトを実行して、employees表の最初の20行をXML文書として取得します。無名のPL/SQLブロックによって、ROWおよびROWSET要素名がEMPおよびEMPSETに変更されます。このブロックは、printClobOut.sqlの実行によって作成されたprintClobOutプロシージャを起動します。
生成されるXML文書には、<EMPSET>文書要素が含まれます。各行は、<EMP>タグによって区切られています。
次のPL/SQLファンクションを起動して、問合せの結果ページを区切ることができます。
setMaxRowsは、XMLに変換する行の最大数を設定します。この最大値は、前回の結果が生成された、現在の行の位置に関連します。
setSkipRowsは、行の値をXMLに変換するときにスキップする行数を指定します。
paginateResult.sqlスクリプトを実行して、結果ページを区切る無名ブロックを実行します。最初の10行のバッチでskipRowsを3に設定し、残りのバッチで0に設定すると、employees表の最初の3行をスキップし、残りの行を一度に10行ずつ出力します。複数のフェッチの場合は、フェッチする行がなくなったときを確認する必要があります。これを行うには、setRaiseNoRowsExceptionを起動します。このプロシージャは、CLOBへの行の書込みがなかった場合に例外を発生させます。この例外は、終了条件として捕捉および使用できます。
XSUのPL/SQL APIは、次の方法で、生成したXML文書にスタイルシートを設定する機能を提供します。
setStylesheetHeaderプロシージャを使用して、結果にスタイルシート・ヘッダーを設定します。このプロシージャは、XML処理命令を追加して、スタイルシートを含めます。
生成の前に、結果のXML文書にスタイルシートを適用します。このメソッドを使用すると、パフォーマンスが大幅に向上します。このメソッドを使用しない場合は、XML文書をCLOBとして生成し、再度パーサーに送信し、スタイルシートを適用する必要があります。XSUはDOM文書を生成してパーサーを起動し、スタイルシートを適用してから結果を生成します。結果のXML文書にスタイルシートを適用するには、スタイルシートを使用して結果を生成する、setXSLTプロシージャを使用します。
XSUのPL/SQL APIは、SQL文に値をバインドする機能を提供します。SQL文には、名前付きバインド変数を指定できます。このバインド変数の前には、コロン(:)を付ける必要があります。bindSQLVariables.sqlスクリプトは、無名のPL/SQLブロックを実行し、employees表の列にEMPLOYEE_IDおよびFIRST_NAMEの値をバインドします。
表またはビューにXML文書を挿入するには、表名またはビュー名、およびXML文書を指定します。XSUはXML文書(文字列が指定されている場合)を解析し、INSERT文を作成してこの文にすべての値をバインドします。デフォルトでは、XSUは値を表またはビューのすべての列に挿入します。存在しない要素はNULLとして処理されます。
insProc.sqlデモ・スクリプトを実行して、PL/SQLストアド・プロシージャinsProcを作成します。このストアド・プロシージャは、次のパラメータを受け入れます。
CLOBとしてのXML文書
文書を挿入する表の名前
insProcプロシージャを起動して、XML文書を表に挿入できます。
insertClob.sqlスクリプトを実行して、xmldocumentという表を作成し、XML文書をCLOBとして表に格納します。XML文書には、従業員7370のLiz Gardnerが記述され、この従業員をhr.employees表に挿入します。
例13-4に示されたinsertEmployee.sqlスクリプトを実行して、insProcストアド・プロシージャをコールし、Liz Gardnerをemployees表に挿入します。
「OracleXMLSaveを使用した行の挿入」に示したように、callinsProcプロシージャを実行すると、例13-5で示す形式のINSERT文が生成されます。
XSUによって、列名と一致している入力XML文書内の要素タグが照合され、その値がバインドされます。
例13-3 insertClob.sql
CREATE TABLE hr.xmldocument
(docid NUMBER PRIMARY KEY,
xml_text CLOB);
-- insert an XML document into the CLOB column
INSERT INTO hr.xmldocument (docid,xml_text)
VALUES (1,
'<?xml version="1.0"?>
<ROWSET>
<ROW num="1">
<EMPLOYEE_ID>7370</EMPLOYEE_ID>
<FIRST_NAME>Liz</FIRST_NAME>
<LAST_NAME>Gardner</LAST_NAME>
<EMAIL>liz.gardner@business.com</EMAIL>
<PHONE_NUMBER>650-555-6127</PHONE_NUMBER>
<HIRE_DATE>12/18/2004 0:0:0</HIRE_DATE>
<SALARY>3000</SALARY>
<COMMISSION_PCT>0</COMMISSION_PCT>
<JOB_ID>SH_CLERK</JOB_ID>
<MANAGER_ID>103</MANAGER_ID>
<DEPARTMENT_ID>20</DEPARTMENT_ID>
</ROW>
</ROWSET>');
例13-4 insertEmployee.sql
DECLARE
v_xml_text CLOB;
BEGIN
SELECT xml_text
INTO v_xml_text
FROM hr.xmldocument
WHERE docid = 1;
insProc(v_xml_text, 'employees');
END;
/
例13-5 INSERT文の形式
INSERT INTO hr.employees (employee_id, first_name, last_name, email, phone_number, hire_date, salary, commission_pct, manager_id, department_id) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);
「OracleXMLSaveを使用した列のサブセットへのXMLの挿入」で説明しているように、値を挿入する必要がない列がある場合もあります。挿入処理を行う列名のリストを作成し、それをDBMS_XMLSaveプロシージャに渡すことができます。setUpdateColumnNameプロシージャを繰り返し起動し、起動するたびに更新する列名を渡すことで、これらの値を設定できます。列名の設定は、clearUpdateColumnListを起動すると消去されます。
testInsert.sqlデモ・スクリプトを実行して、testInsertというPL/SQLストアド・プロシージャを作成します。このプロシージャを使用して、CLOB型のXMLデータをhr.employees表に挿入できます。
例13-6のinsertClob2.sqlスクリプトを実行して、新しい従業員Jordanについて記述されたXML文書をxmldocument表のCLOB列に挿入します。文書に、employees表のすべての列に対応する要素が含まれるわけではありません。
例13-7のinsertEmployee2.sqlスクリプトを実行すると、従業員Jim Jordanのデータがhr.employees表の列のサブセットに挿入されます。
「OracleXMLSaveを使用した列のサブセットへのXMLの挿入」の場合と同様に、testInsertを起動すると、次のINSERT文が生成されます。
INSERT INTO hr.employees (employee_id, last_name, email, job_id, hire_date) VALUES (?, ?, ?, ?, ?);
例13-6 insertClob2.sql
-- insert an XML document into the CLOB column of the xmldocument table with only
-- some of the possible elements
INSERT INTO hr.xmldocument (docid, xml_text)
VALUES (2,
'<?xml version="1.0"?>
<ROWSET>
<ROW num="1">
<EMPLOYEE_ID>7401</EMPLOYEE_ID>
<LAST_NAME>Jordan</LAST_NAME>
<EMAIL>jim.jordan@business.com</EMAIL>
<JOB_ID>SH_CLERK</JOB_ID>
<HIRE_DATE>12/17/2004 0:0:0</HIRE_DATE>
</ROW>
</ROWSET>');
例13-7 insertEmployee2.sql
DECLARE
v_xml_text CLOB;
BEGIN
SELECT xml_text
INTO v_xml_text
FROM hr.xmldocument
WHERE docid = 2;
testInsert(v_xml_text);
END;
/
「OracleXMLSaveを使用した行の更新」で説明しているように、XML文書を使用して表内の指定したフィールドを更新できます。キーとして使用する列を指定するか、更新する列のリストを渡すことができます。
testUpdateKey.sqlスクリプトを実行して、testUpdateKeyというPL/SQLプロシージャを作成します。このプロシージャは、hr.employees表のemployee_id列を主キーとして使用します。
例13-8のinsertClob3.sqlスクリプトを実行して、xmldocument表のCLOB列にXML文書を挿入します。この文書は、従業員7400の新しい給与、および従業員7369の新しい仕事のIDおよびマネージャIDを指定します。
例13-9のupdateEmployee.sqlスクリプトを実行して、testUpdateKeyプロシージャにXML文書を渡し、2つのUPDATE文を生成します。
最初のROW要素には、次のUPDATE文が生成されます。
UPDATE hr.employees SET salary = 3250 WHERE employee_id = 7400;
2番目のROW要素には、次の文が生成されます。
UPDATE hr.employees SET job_id = 'SA_REP' AND MANAGER_ID = 145 WHERE employee_id = 7369;
例13-8 insertClob3.sql
INSERT INTO hr.xmldocument (docid, xml_text)
VALUES (3,
'<?xml version="1.0"?>
<ROWSET>
<ROW num="1">
<EMPLOYEE_ID>7400</EMPLOYEE_ID>
<SALARY>3250</SALARY>
</ROW>
<ROW num="2">
<EMPLOYEE_ID>7369</EMPLOYEE_ID>
<JOB_ID>SA_REP</JOB_ID>
<MANAGER_ID>145</MANAGER_ID>
</ROW>
</ROWSET>');
例13-9 updateEmployee.sql
DECLARE
v_xml_text CLOB;
BEGIN
SELECT xml_text
INTO v_xml_text
FROM hr.xmldocument
WHERE docid = 3;
testUpdateKey(v_xml_text);
END;
/
「OracleXMLSaveを使用した列リストの更新」で説明しているように、更新する列のリストを指定できます。
testUpdateSubset.sqlスクリプトを実行すると、PL/SQLプロシージャtestUpdateSubsetが作成されます。このプロシージャはemployee_id列をキーとして使用し、hr.employees表のsalaryおよびjob_id列のみを更新します。
insertClob4.sqlスクリプトを実行して、xmldocument表にXML文書を挿入します。文書内の<ROW>要素には、従業員100および206の記述があります。各<ROW>要素には、説明テキストを含む10個のサブ要素があります。
例13-10のupdateEmployee2.sqlスクリプトを実行して、testUpdateSubsetプロシージャにXML CLOBを渡し、2つのUPDATE文を生成します。
プロシージャは、従業員100および206に関して、setUpdateColumnプロシージャで指定された列、salaryおよびemailのみを更新します。
例13-10 updateEmployee2.sql
DECLARE
v_xml_text CLOB;
BEGIN
SELECT xml_text
INTO v_xml_text
FROM hr.xmldocument
WHERE docid = 4;
testUpdateSubset(v_xml_text);
END;
/
「OracleXMLSaveを使用した行の削除」で説明しているように、XSUが使用するキー列のリストを指定して、削除する行を決定できます。これらの列は、DELETE文のWHERE句で指定されます。
testDeleteRow.sqlスクリプトを実行して、testDeleteRow PL/SQLプロシージャを作成します。プロシージャは、入力XML文書のすべての<ROW>要素に対して、hr.employees表から行を削除します。
例13-7で追加した従業員Jim Jordanを削除する必要があるとします。例13-11のdeleteEmployeeByRow.sqlスクリプトを実行して、XML文書をCLOBとしてtestDeleteRowストアド・プロシージャに渡します。
前述のtestDeleteRowの起動は、次のDELETE文を生成します。
DELETE FROM hr.employees WHERE employee_id = 7401 AND last_name = 'JORDAN' AND email = 'jim.jordan@business.com' AND job_id = 'SH_CLERK' AND hire_date = '12/17/2004 0:0:0';
プログラムは、XML文書内の各<ROW>要素にあるタグ名に基づいてDELETE文を構成します。
例13-11 行による削除
DECLARE
v_xml_text CLOB;
BEGIN
SELECT xml_text
INTO v_xml_text
FROM hr.xmldocument
WHERE docid = 2;
testDeleteRow(v_xml_text);
END;
/
「OracleXMLSaveを使用したキーによる削除」で説明したように、削除操作の主キーとして使用する列を指定できます。DBMS_XMLSave.setKeyColumnファンクションを使用してキーを指定します。
testDeleteKey.sqlを実行して作成されたtestDeleteKeyプロシージャは、入力XML文書のすべての<ROW>要素に対してemployees表から行を削除します。
例13-4で追加した従業員Liz Gardnerを削除する必要があるとします。例13-12のdeleteEmployeeByKey.sqlスクリプトを実行して、XML文書をCLOBとしてtestDeleteKeyストアド・プロシージャに渡します。
プロシージャ・コールで、XSUは次のような単一のDELETE文を生成します。
DELETE FROM hr.employees WHERE employee_id=?
XSUはこの文を入力XML文書のすべてのROW要素に使用します。
例13-12 キーによる削除
DECLARE
v_xml_text CLOB;
BEGIN
SELECT xml_text
INTO v_xml_text
FROM hr.xmldocument
WHERE docid = 1;
testDeleteKey(v_xml_text);
END;
/
優れたPL/SQLコードは、発生可能な例外を考慮して作成されています。raiseException.sqlの無名PL/SQLブロックは、DBMS_XMLQuery.getExceptionContentプロシージャの起動方法を実例で示します。SQL*Plusでスクリプトを実行して、次のエラー・メッセージを出力します。
Exception caught 904 ORA-00904: "Z": invalid identifier
前項で示したDMLの例では、同じコンテキスト・ハンドルを複数の操作のために使用できます。saveコンテキストを作成したときに指定した同一の表に対してすべての挿入が行われる場合は、同じコンテキストを使用して複数のINSERTを実行できます。同じコンテキストを使用してDML文を混合することもできます。
testDML.sqlスクリプトは、同じコンテキストおよび設定を使用して、ユーザーの入力に基づいてDMLを実行する方法を示します。この例では、すべてのファンクションの起動で同じコンテキストが使用されるように、PL/SQLパッケージの静的変数を使用してコンテキストを格納します。
スクリプトによって作成されたtestDMLパッケージでは、パッケージ全体(セッション)のためのコンテキストを1回作成し、複数のDML操作でコンテキストを再利用します。
注意:
キー列employee_idが、行を識別する方法として更新と削除の両方に使用されることに注意してください。
スクリプトによって作成された3つのプロシージャのどれをコールしてもemployees表を更新できます。
testDML.insertXML(xmlclob); testDML.deleteXML(xmlclob); testDML.updateXML(xmlclob);
各プロシージャ・コールが同じコンテキストを使用することで、これらの操作が頻繁に実行される場合は特にパフォーマンスが向上します。
表の基本コンポーネントは列ですが、XML文書の基本コンポーネントは要素と属性です。表はどのようにXML文書にマップされるのでしょうか。たとえば、hr.employees表にlast_nameという列がある場合、この構造はXMLで、last_name属性を持つ<EMPLOYEES>要素、または異なるルート要素内の<LAST_NAME>要素として表現されますが、これはどのような方法で行われるのでしょうか。この項では、これらの疑問に答えるため、SQLからXMLおよびXMLからSQLへのマッピングについて説明します。
内容は次のとおりです。
hr.employees表の列のデータをXML文書として表示するには、次のようにコマンドラインでXSUを実行します。
java OracleXML getXML -user "hr/password" -withschema \
"SELECT employee_id, last_name, hire_date FROM employees"
XSUは、入力された問合せに基づいてXML文書を出力します。ドキュメントのルート要素は<DOCUMENT>です。次にサンプル出力を示します。関連のない行はコメントに置き換えられています。
<?xml version = '1.0'?>
<DOCUMENT xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<!-- children of schema element ... -->
</xsd:schema>
<ROWSET xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="#/DOCUMENT/xsd:schema[not(@targetNamespace)]">
<ROW num="1">
<EMPLOYEE_ID>100</EMPLOYEE_ID>
<LAST_NAME>King</LAST_NAME>
<HIRE_DATE>6/17/1987 0:0:0</HIRE_DATE>
</ROW>
<!-- additional rows ... -->
</ROWSET>
</DOCUMENT>
生成されたXMLでは、SQL問合せによって戻された行は<ROWSET>要素の子です。XML文書には次の機能があります。
<ROWSET>要素には、戻された行数に応じて、0個以上の<ROW>子要素があります。問合せによって行が生成されなかった場合、<ROW>要素は含まれません。問合せによって行が1つ生成された場合は、1個の<ROW>要素が含まれます。
各<ROW>要素には、1つの表の行のデータが含まれます。特に、各<ROW>要素には、SELECT文で指定されたデータベースの列と同一の名前およびコンテンツを持つ子要素が1つ以上あります。
オブジェクト・リレーショナル・スキーマからXML文書を生成する場合を考えてみます。SQL*PlusでcreateObjRelSchema.sqlスクリプトを実行して、オブジェクト・リレーショナル・スキーマを設定し、データを挿入します。スキーマには、ユーザー定義型を使用する2つの列を持つdept1表があります。
コマンドラインからXSUを起動して、次のようにdept1表の問合せを実行できます。
% java OracleXML getXML -user "hr/password" -withschema "SELECT * FROM dept1"
XSUは、例13-13のXML文書を戻します。このXML文書では、関連のない行はコメントに置き換えられています。
前述の例と同様に、この例は正規のマッピングを示しています。<ROWSET>には<ROW>子要素が含まれ、これらの子要素には、dept1の列に対応した子要素が含まれます。たとえば、<DEPTNAME>要素は、dept1.deptname列に対応しています。スカラー型の列に対応する要素は、列からのデータを含みます。
例13-13 XSUにより生成されたサンプル文書
<?xml version='1.0'?>
<DOCUMENT xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<schema targetNamespace="http://xmlns.oracle.com/xdb/SYSTEM"
xmlns="http://www.w3.org/2001/XMLSchema"
xmlns:SYSTEM="http://xmlns.oracle.com/xdb/SYSTEM">
<!-- children of schema element ... -->
</xsd:schema>
<ROWSET xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="#/DOCUMENT/xsd:schema[not(@targetNamespace)]">
<ROW num="1">
<DEPTNO>120</DEPTNO>
<DEPTNAME>Treasury</DEPTNAME>
<DEPTADDR>
<STREET>2004 Charade Rd</STREET>
<CITY>Seattle</CITY>
<STATE>WA</STATE>
<ZIP>98199</ZIP>
</DEPTADDR>
<EMPLIST>
<EMPLIST_ITEM>
<EMPLOYEE_ID>1</EMPLOYEE_ID>
<LAST_NAME>Mehta</LAST_NAME>
<SALARY>6000</SALARY>
<EMPLOYEE_ADDRESS>
<STREET>500 Main Road</STREET>
<CITY>Seattle</CITY>
<STATE>WA</STATE>
<ZIP>98199</ZIP>
</EMPLOYEE_ADDRESS>
</EMPLIST_ITEM>
</EMPLIST>
</ROW>
</ROWSET>
</DOCUMENT>
複雑な型の列に対応する要素の場合、マッピングはより複雑になります。例13-13で、<DEPTADDR>は、オブジェクト型AddressTypeのdept1.deptAddr列に対応しています。したがって、<DEPTADDR>は、AddressType型で指定された属性に対応する子要素を含みます。AddressTypeの属性streetは、子XML要素<STREET>に対応し、他の属性も同様にそれぞれの子要素に対応しています。これらのサブ要素は、対応する属性の型が単純か複雑かによって、それ自体がデータやサブ要素を含む場合があります。
データベースのコレクションに対応する要素を処理する場合も、マッピングの方法が異なります。例13-13で、<EMPLIST>要素は、EmployeeListType型のemplist列に対応します。したがって、<EMPLIST>要素は、それぞれがコレクションの要素に対応する<EMPLIST_ITEM>要素のリストを含みます。注意:
<ROW>要素は、カーディナリティ属性numを含みます。
特定の列または属性の値がNULLの場合、その行では、対応するXML要素が省略されます。
最上位のスカラー列の名前がアットマーク(@)で始まる場合、その列はXML要素ではなくXML属性にマップされます。
XMLからSQLへのマッピングは、SQLからXMLへのマッピングの逆の操作です。XSUを使用してXMLからSQLへのマッピングを行う場合は、次の相違点を考慮に入れてください。
XMLからSQLへの変換では、XSUはXML属性を無視します。したがって、XML属性は実際にはSQLにマップされません。
SQLからXMLへの変換では、XSUはSQL問合せによって作成された単一のResultSetに対してマッピングを行います。問合せは、複数のデータベース表またはビューに対して実行できます。XMLからSQLへの変換では、次の点に注意してください。
1つのXML文書を複数の表またはビューに挿入するには、ターゲットのスキーマにオブジェクト・リレーショナル・ビューを作成する必要があります。
ビューが更新不可能な場合は、INSTEAD OF INSERTトリガーを使用できます。
XML文書がターゲットのデータベース・スキーマに完全にマップされない場合は、次の方法で対処できます。
ターゲットを変更します。ターゲットのスキーマにオブジェクト・リレーショナル・ビューを作成し、そのビューを新しいターゲットにします。
XSLTを使用してXML文書を変換して、XML文書を変更します。XSLTスタイルシートをXSUに登録すると、マッピングを試行する前に、受信したXMLを自動的に変換できます。
XSUのXMLからSQLへのマッピングを変更します。XML要素とデータベースの列または属性の一致で大/小文字を区別するように、XSUに対して指示できます。たとえば、XSUに対して次のことを指示できます。
ROWのかわりに、データベースの行に対応する要素名を使用
XML文書の日付を解析するときに使用する日付書式の指定
特定の構造を持つXMLを生成する必要がある場合もあります。生成されたXML文書のデフォルトの構造が要求する構造と異なる場合があるため、このプロセスにはある程度の柔軟性が必要になります。次のいずれかの方法を使用して、生成されたXML文書の構造をカスタマイズできます。
ソースのカスタマイズは、SQL問合せまたはデータベース・スキーマを変更することによって行います。最も単純で強力なソースのカスタマイズは次のとおりです。
データベース・スキーマで、任意のXML文書構造にマップするオブジェクト・リレーショナル・ビューを作成します。
問合せで次のようにします。
カーソル副問合せまたはキャスト多重集合構造を使用して、フラットなスキーマから取得したXML文書でネストを作成します。
列名および属性名に別名を付けて、目的のXML要素を取得します。
アットマーク(@)で始まる識別子を使用して、最上位のスカラー型の列に別名を付け、これらの列をXML要素ではなくXML属性にマップします。たとえば、次の文を実行すると、<ROW>要素が属性empnoを持つXML文書が生成されます。
SELECT employee_name AS "@empno",... FROM employees;
例13-14のcustomer.xml文書について考えてみます。
データベース表のセットを設計して、このデータを格納する必要があるとします。XMLは複数のレベルを持つネスト構造であるため、前述のXML文書に正規マッピングされるオブジェクト・リレーショナル・データベース・スキーマを使用できます。SQL*PlusでcreateObjRelSchema2.sqlスクリプトを実行して、このようなデータベース・スキーマを作成します。
スクリプトによって作成されるcustomer_tab表に、customer.xml文書のデータをロードできます。次のようにコマンドラインからXSU for Javaを起動します。
java OracleXML putXML -user "hr/password" -fileName customer.xml customer_tab
オブジェクト・リレーショナルでないデータベース・スキーマにcustomer.xmlをロードするには、標準のリレーショナル・スキーマの最上位にオブジェクトのビューを作成します。たとえば、必要な列を含むリレーショナル表を作成し、最上位にカスタマ・オブジェクトを持つカスタマ・ビューを作成できます。例13-15に、createRelSchema.sqlスクリプトを示します。
次のようにデータをcustomer_viewにロードできます。
java OracleXML putXML -user "hr/password" -fileName customer.xml customer_view
または、XSLTを使用してXMLをフラット化し、このXMLをリレーショナル・スキーマに直接挿入することもできます。ただし、この方法は、あまりお薦めできません。
特定の列または列のグループをXML要素ではなくXML属性にマップするには、列名に別名を作成し、この別名の前にアットマーク(@)を付加します。たとえば、mapColumnToAtt.sqlスクリプトを使用してhr.employees表に問合せを行い、employee_idをXML属性としてレンダリングできます。
次のようにしてコマンドラインからmapColumnToAtt.sqlスクリプトを実行できます。
java OracleXML getXML -user "hr/password" -fileName "mapColumnToAtt.sql"
注意:
すべてのXML属性の列を先にマップする必要があります。
例13-14 customer.xml
<?xml version = "1.0"?>
<ROWSET>
<ROW num="1">
<CUSTOMER>
<CUSTOMERID>1044</CUSTOMERID>
<FIRSTNAME>Paul</FIRSTNAME>
<LASTNAME>Astoria</LASTNAME>
<HOMEADDRESS>
<STREET>123 Cherry Lane</STREET>
<CITY>SF</CITY>
<STATE>CA</STATE>
<ZIP>94132</ZIP>
</HOMEADDRESS>
</CUSTOMER>
</ROW>
</ROWSET>
例13-15 createRelSchema.sql
CREATE TABLE hr.cust_tab
( customerid NUMBER(10),
firstname VARCHAR2(20),
lastname VARCHAR2(20),
street VARCHAR2(40),
city VARCHAR2(20),
state VARCHAR2(20),
zip VARCHAR2(20)
);
CREATE VIEW customer_view
AS
SELECT customer_type(customerid, firstname, lastname,
address_type(street,city,state,zip)) customer
FROM cust_tab;
この項では、XSUとデータベースの対話方法について説明します。
XSUはSQL問合せを実行し、データベースからResultSetを取得します。次に、XSUはResultSetに関するメタデータを取得し、分析します。「SQLからXMLへのデフォルト・マッピング」で説明したマッピングを使用して、XSUはSQLの結果セットを処理し、XML文書に変換します。
XSUは、特定の種類の問合せを処理できません。特に、LONG型またはLONG RAW型の列とSELECT句のCURSOR()式が混在している場合、処理できません。LONGおよびLONG RAWは、JDBCがストリームとしてアクセスするデータ型の例で、使用は推奨されません。これらの列をCLOBに移行すると、問合せは成功します。
XML文書のコンテンツを表またはビューに挿入するとき、XSUは次の手順を実行します。
ターゲットの表またはビューに関するメタデータを取得します。
メタデータに基づいて、SQL INSERT文を生成します。たとえば、ターゲット表がdept1で、dept1からXML文書が生成されるとします。XSUによって次のINSERT文が生成されます。
INSERT INTO dept1 (deptno, deptname, deptaddr, emplist) VALUES (?,?,?,?)
XML文書を解析し、各レコードに対して、適切な列または属性に適切な値をバインドします。たとえば、INSERT文に次のような値をバインドします。
deptno <- 100
deptname <- SPORTS
deptaddr <- AddressType('100 Redwood Shores Pkwy','Redwood Shores',
'CA','94065')
emplist <- EmployeeListType(EmployeeType(7369,'John',100000,
AddressType('300 Embarcadero','Palo Alto','CA','94056'),...)
文を実行します。INSERT処理を最適化して、バッチで挿入およびコミットできます。
関連項目:
バッチの詳細は、「OracleXMLSaveを使用した行の挿入」を参照してください
更新および削除の文は、データベース表内の2つ以上の行に影響するという点で挿入と異なります。挿入では、表にトリガーまたは制約がない場合は、XML文書の1つの<ROW>要素の影響を受けるのは表内で最大1つの行のみです。更新および削除では、一致する列が表内のキー列でない場合は、XML要素が2つ以上の行と一致する場合があります。
更新の文には、更新する行を識別するためにXSUが必要とするキー列のリストを提供する必要があります。たとえば、次のフラグメントを含むXML文書があるとします。
<ROWSET>
<ROW num="1">
<DEPTNO>100</DEPTNO>
<DEPTNAME>SportsDept</DEPTNAME>
</ROW>
</ROWSET>
DEPTNAMEの値をSportsからSportsDeptに変更します。DEPTNOをキー列として指定すると、XSUは次のUPDATE文を生成します。
UPDATE dept1 SET deptname = ? WHERE deptno = ?
XSUは、次のように値をバインドします。
deptno <- 100 deptname <- SportsDept
更新の場合は、XML文書にあるすべての要素を更新するのではなく、列の集合のみを更新するように選択できます。
削除の場合は、削除する行をXSUが識別できるように、キー列の集合を指定するように選択できます。キー列の集合を指定しないと、DELETE文は文書にあるすべての列を一致させようとします。XSUに渡す次のような文書があるとします。
<ROWSET>
<ROW num="1">
<DEPTNO>100</DEPTNO>
<DEPTNAME>Sports</DEPTNAME>
<DEPTADDR>
<STREET>100 Redwood Shores Pkwy</STREET>
<CITY>Redwood Shores</CITY>
<STATE>CA</STATE>
<ZIP>94065</ZIP>
</DEPTADDR>
</ROW>
<!-- additional rows ... -->
</ROWSET>
XSUは、各ROW要素に対してDELETE文を構築します。
DELETE FROM dept1 WHERE deptno = ? AND deptname = ? AND deptaddr = ?
バインドは次のとおりです。
deptno <- 100
deptname <- sports
deptaddr <- addresstype('100 redwood shores pkwy','redwood city','ca',
'94065')
