XML シリアライゼーション

XML シリアライゼーションは、XML データを Db2® 表における内部表記から、アプリケーションにおけるテキスト XML 形式に変換する処理です。

XMLSERIALIZE 関数を呼び出して、Db2 データベース・サーバーが XML データをクライアント・アプリケーションに送信する前に XML シリアライゼーションを行うように要求することができます。 このプロセスを明示的なシリアライゼーションといいます。あるいは、XMLSERIALIZE 呼び出しを省略して、 XML 列からアプリケーション変数にデータを直接取り出すこともできます。 Db2 データベース・サーバー は、XML データの取り出し時にデータをシリアライズします。 このプロセスを暗黙的なシリアライゼーションといいます。

暗黙的なシリアライゼーションでは、クライアントが XML データ・タイプをサポートする場合、 データはクライアントに送られるときに XML タイプになります。 Db2 ODBC および 組み込み SQL アプリケーションでは、Db2 データベース・サーバーが XML 宣言を 適切なエンコード方式の指定と共にデータに追加します。 Java アプリケーションの場合、非推奨の DB2Xml.getDB2Xmlxxx メソッドを使用してデータを取り出す場合でなければ、Db2 データベース・サーバーは XML 宣言を追加しません。

ほとんどの場合において、暗黙的なシリアライゼーションの方が推奨される方法といえます。 XML データをクライアントに送ることにより、Db2 クライアントは XML データを適切に処理することができます。 明示的なシリアライゼーションでは、クライアントによる追加処理が必要になります。

シリアライゼーションを避けるために、 テキスト XML データとしてではなく、バイナリー XML 形式 (拡張可能動的バイナリー XML Db2 クライアント/サーバー・バイナリー XML 形式) で XML データを取り出すことができます。バイナリー XML 形式でのデータ取り出しは、 JDBC、SQLJ、または ODBC のアプリケーションでのみ、 または UNLOAD ユーティリティーによってのみサポートされます。

XMLSERIALIZE を明示的に呼び出した後に、データはデータベース・サーバー内で非 XML データ・タイプとなり、 そのデータ・タイプでクライアントに送られます。

XMLSERIALIZE では、以下を指定できます。
  • データがシリアライズされるときの、変換後の SQL データ・タイプ

    指定できるデータ・タイプは、CLOB、BLOB、DBCLOB です。

  • 出力データに以下の明示的な XML 宣言が含まれるかどうか (EXCLUDING XMLDECLARATION または INCLUDING XMLDECLARATION)
    <?xml version="1.0" encoding="UTF-8"?>
XMLSERIALIZE からの出力は、Unicode UTF-8 でエンコードされたデータとなります。

XMLSERIALIZE の実行時にエンコード方式の指定を明示的に要求することの影響をよく理解しておく必要があります。テキスト XML データを取り出してバイナリーではないデータ・タイプにする場合、 データはアプリケーションのエンコード方式に変換されますが、エンコード方式の指定は変更されません。 そのため、データのエンコード方式が、エンコード方式の指定と一致しない可能性があります。 この場合、エンコード方式の名前に依存しているアプリケーション・プロセスで XML データを構文解析できなくなります。

一般に、暗黙的なシリアライゼーションが推奨される方法です。ただし、以下の状況では、明示的な XMLSERIALIZE を行う方が優れています。
  • XML 文書が非常に大きいとき

    XML ロケーターがないため、XML 文書が非常に大きいときは、 XMLSERIALIZE を使用してデータを LOB タイプに変換し、LOB ロケーターを使用できるようにする必要があります。

  • クライアントが XML データをサポートしないとき

    クライアントが XML データ・タイプをサポートしない、以前のバージョンである場合、 暗黙的な XML シリアライゼーションを使用すると、 Db2 データベース・サーバーは データを BLOB データ・タイプに変換します。 取り出したデータを別のデータ・タイプにしたい場合には、XMLSERIALIZE を呼び出す SQL ステートメントを 動的に実行して、CLOB または DBCLOB 出力を指定できます。

  • XML データをストアード・プロシージャーまたはユーザー定義関数に渡したいとき

    Db2 for z/OS® ストアード・プロシージャー およびユーザー定義関数は、XML データ・タイプのパラメーターをサポートしません。 そのため、XML 列からルーチンにデータを渡したい場合には、 そのデータについて XMLSERIALIZE を呼び出して、BLOB、CLOB、または DBCLOB タイプに変換する必要があります。

XML データの変換先として最適なデータ・タイプは BLOB データ・タイプです。バイナリー・データを検索するとエンコード方式に関する問題が少なくなるためです。

例: サンプル表 Customer 内の XML 列 Info に、以下のデータと階層的に同等のものが入った文書が入っています。
<customerinfo xml:space="default" xmlns="http://posample.org" Cid='1000'>
  <name>Kathy Smith</name>
  <addr country='Canada'>
  <street>5 Rosewood</street>
  <city>Toronto</city>
  <prov-state>Ontario</prov-state>
  <pcode-zip>M6W 1E6</pcode-zip>
  </addr>
  <phone type='work'>416-555-1358</phone>
</customerinfo>
データを取り出してホスト変数に入れる前に、XMLSERIALIZE を呼び出してデータをシリアライズし、BLOB タイプに変換します。
SELECT XMLSERIALIZE(Info as BLOB(1M)) from Customer
  WHERE CID='1000'
例: C プログラムで、カスタマー ID 1000 の customerinfo 文書を取り出し 、BLOB ホスト変数として XML に入れます。こうすることにより、暗黙的な XML シリアライゼーションを行います。 取り出されたデータは UTF-8 コード化スキームによるもので、XML 宣言を含んでいます。
EXEC SQL BEGIN DECLARE SECTION;
 SQL TYPE IS XML AS BLOB (1M) xmlCustInfo;
EXEC SQL END DECLARE SECTION;
…
EXEC SQL SELECT INFO INTO :xmlCustInfo
  FROM Customer
  WHERE Cid=1000;
例: この JDBC プログラムは、 バイナリー・データ形式でデータを取り出すことにより XML シリアライゼーションを 回避します。プログラムは、DataSource のプロパティー xmlFormat にデータがバイナリー XML 形式で取り出されるようにする指示を 設定します。そうすると、プログラムは、カスタマー ID 1000 の customerinfo 文書を取り出し SQLXML オブジェクトに入れます。次に、プログラムはデータを SQLXML オブジェクトから取り出して DOMSource オブジェクトに入れるため、 取り出されたデータは非テキスト表記です。この手法には、JDBC 4.0 以降が必要です。
import java.sql.*;                        // JDBC base
import com.ibm.db2.jcc.*;                 // IBM Data Server Driver for JDBC
                                          // and SQLJ implementation of JDBC
…
com.ibm.db2.jcc.DB2SimpleDataSource db2ds =  
  new com.ibm.db2.jcc.DB2SimpleDataSource();
                                          // Create the DataSource object
db2ds.setDriverType(4);                   // Set the driver type
db2ds.setDatabaseName("san_jose");        // Set the location
db2ds.setUser("db2adm");                  // Set the user
db2ds.setPassword("db2adm");              // Set the password
db2ds.setServerName("mvs1.sj.ibm.com");  
                                          // Set the server name
db2ds.setPortNumber(5021);                // Set the port number
db2ds.setXMLFormat(
  com.ibm.db2.jcc.DB2BaseDataSource.XML_FORMAT_BINARY);
                                          // Set XML format to binary
…
Statement stmt = conn.createStatement();
ResultSet rs = stmt.executeQuery("SELECT INFO FROM Customer WHERE Cid='1000'");
SQLXML sqlxml = rs.getSQLXML(1);
DOMSource domSource = sqlxml.getSource(DOMSource.class); 
                                         // Get a DOMSource object from 
                                         // the SQLXML object, to avoid
                                         // XML serialization
Document document = (Document) domSource.getNode();