組み込み SQL アプリケーションにおける XML データのホスト変数データ・タイプ

Db2® では、 アセンブラー、C、C++、COBOL、および PL/I 用の XML ホスト変数タイプが用意されています。

以下のタイプがあります。
  • XML AS BLOB
  • XML AS CLOB
  • XML AS DBCLOB
  • XML AS BLOB_FILE (C, C++, or PL/I) or XML AS BLOB-FILE (COBOL)
  • XML AS CLOB_FILE (C, C++, or PL/I) or XML AS CLOB-FILE (COBOL)
  • XML AS DBCLOB_FILE (C, C++, or PL/I) or XML AS DBCLOB-FILE (COBOL)
XML ホスト変数タイプは、XML 列データ・タイプとのみ互換性があります。

XML 列を更新する場合は、BLOB、 CLOB、 DBCLOB、 CHAR、 VARCHAR、 GRAPHIC、 VARGRAPHIC、 BINARY、 または VARBINARY ホスト変数を使用できます。XMLPARSE 関数を使用してホスト変数データ・タイプを XML タイプ に変換するか、あるいは、Db2 データベース・サーバーにより暗黙的に変換を行うことができます。

XML 列からデータを取り出す場合は、BLOB、 CLOB、 DBCLOB、 CHAR、 VARCHAR、 GRAPHIC、 VARGRAPHIC、 BINARY、 または VARBINARY ホスト変数を使用できます。XMLSERIALIZE 関数を使用して XML データをホスト変数タイプに 変換するか、あるいは、Db2 データベース・サーバーにより暗黙的に変換を行うことができます。

以下の例は、サポートされている各言語における XML ホスト変数の宣言方法を示しています。 各表の左の列には、アプリケーション・プログラムでコードする宣言が示されています。 右の列には、Db2 が 生成する宣言が示されています。

アセンブラーにおける XML ホスト変数の宣言

以下の表は、 いくつかの代表的な XML タイプのアセンブラー言語による宣言を示しています。

表 1. アセンブラーによる XML 変数宣言の例
プログラムで宣言する変数 Db2 が生成する変数
BLOB_XML SQL TYPE IS XML AS BLOB 1M
BLOB_XML DS   0FL4      
BLOB_XML_LENGTH DS FL4  
BLOB_XML_DATA DS CL655351
 ORG   *+(983041)
CLOB_XML SQL TYPE IS XML AS CLOB 40000K
CLOB_XML DS   0FL4      
CLOB_XML_LENGTH DS FL4  
CLOB_XML_DATA DS CL655351
 ORG   *+(40894465)     
DBCLOB_XML SQL TYPE IS XML AS DBCLOB 4000K
DBCLOB_XML DS   0FL4      
DBCLOB_XML_LENGTH DS FL4  
DBCLOB_XML_DATA DS GL655342
 ORG   *+(4030466)        
BLOB_XML_FILE SQL TYPE IS XML AS BLOB_FILE
BLOB_XML_FILE DS   0FL4          
BLOB_XML_FILE_NAME_LENGTH DS FL4 
BLOB_XML_FILE_DATA_LENGTH DS FL4 
BLOB_XML_FILE_FILE_OPTIONS DS FL4
BLOB_XML_FILE_NAME DS CL255      
CLOB_XML_FILE SQL TYPE IS XML AS CLOB_FILE
CLOB_XML_FILE DS   0FL4          
CLOB_XML_FILE_NAME_LENGTH DS FL4 
CLOB_XML_FILE_DATA_LENGTH DS FL4 
CLOB_XML_FILE_FILE_OPTIONS DS FL4
CLOB_XML_FILE_NAME DS CL255      
DBCLOB_XML_FILE SQL TYPE IS XML AS DBCLOB_FILE
DBCLOB_XML_FILE DS   0FL4          
DBCLOB_XML_FILE_NAME_LENGTH DS FL4 
DBCLOB_XML_FILE_DATA_LENGTH DS FL4 
DBCLOB_XML_FILE_FILE_OPTIONS DS FL4
DBCLOB_XML_FILE_NAME DS CL255      
注 :
  1. アセンブラー言語では、65535 バイトを超える文字宣言が許可されていないため、 Db2 は、 65535 バイトを超える XML AS BLOB および XML AS CLOB ホスト変数のホスト言語宣言を 2 つの部分に分割します。
  2. アセンブラー言語では、65534 バイトを超えるグラフィック宣言が許可されていないため、 Db2 は、 65534 バイトを超える XML AS DBCLOB ホスト変数のホスト言語宣言を 2 つの部分に分割します。

C における XML ホスト変数の宣言

以下の表は、 いくつかの代表的な XML タイプについて Db2 プリコンパイラーで生成される C および C++ 言語による宣言を示しています。 Db2 コプロセッサーが生成する宣言は、少し異なる場合があります。

表 2. C 言語による変数宣言の例
プログラムで宣言する変数 Db2 が生成する変数
SQL TYPE IS XML AS BLOB (1M) blob_xml;
struct                    
{ unsigned long length;   
  char data??(1048576??); 
} blob_xml;               
SQL TYPE IS XML AS CLOB(40000K) clob_xml;
struct                    
{ unsigned long length;   
  char data??(40960000??);
} clob_xml;               
SQL TYPE IS XML AS DBCLOB (4000K) dbclob_xml;
struct                             
{ unsigned long length;            
  unsigned short data??(4096000??);
} dbclob_xml;                      
SQL TYPE IS XML AS BLOB_FILE blob_xml_file;
struct {                   
unsigned long name_length; 
unsigned long data_length; 
unsigned long file_options;
char name??(255??);        
} blob_xml_file;           
SQL TYPE IS XML AS CLOB_FILE clob_xml_file;
struct {                   
unsigned long name_length; 
unsigned long data_length; 
unsigned long file_options;
char name??(255??);        
} clob_xml_file;           
SQL TYPE IS XML AS DBCLOB_FILE dbclob_xml_file;
struct {                   
unsigned long name_length; 
unsigned long data_length; 
unsigned long file_options;
char name??(255??);        
} dbclob_xml_file;         

COBOL での XML ホスト変数の宣言

COBOL に対して生成される宣言は、 Db2 プリコンパイラー を使用するか、Db2 コプロセッサーを使用するかによって異なります。

以下の表は、 いくつかの代表的な XML タイプについて Db2 プリコンパイラーで生成される COBOL による宣言を示しています。

表 3. Db2 プリコンパイラーによる COBOL 変数宣言の例
プログラムで宣言する変数 Db2 プリコンパイラーが生成する変数
01  BLOB-XML USAGE IS
    SQL TYPE IS XML AS BLOB(1M).
01  BLOB-XML.
  02  BLOB-XML-LENGTH
      PIC 9(9) COMP.
  02  BLOB-XML-DATA.
      49  FILLER PIC X(32767).1
      49  FILLER PIC X(32767).
      Repeat 30 times
⋮
      49  FILLER
          PIC X(1048576-32*32767).
01  CLOB-XML USAGE IS
    SQL TYPE IS XML AS CLOB(40000K).
01  CLOB-XML.
  02  CLOB-XML-LENGTH
      PIC 9(9) COMP.
  02  CLOB-XML-DATA.
      49  FILLER PIC X(32767).1
      49  FILLER PIC X(32767).
      Repeat 1248 times
⋮
      49  FILLER
          PIC X(40960000-1250*32767).
01  DBCLOB-XML USAGE IS
  SQL TYPE IS XML AS DBCLOB(4000K).
01  DBCLOB-XML.
  02  DBCLOB-XML-LENGTH
      PIC 9(9) COMP.
  02  DBCLOB-XML-DATA.
      49  FILLER PIC G(32767)
            USAGE DISPLAY-1.2
      49  FILLER PIC G(32767)
            USAGE DISPLAY-1.
      Repeat 123 times
⋮
      49  FILLER
          PIC G(4096000-125*32767)
            USAGE DISPLAY-1.
01  BLOB-XML-FILE USAGE IS SQL
  TYPE IS XML AS BLOB-FILE.
01  BLOB-XML-FILE.                              
  49 BLOB-XML-FILE-NAME-LENGTH PIC S9(9) COMP-5 SYNC.
  49 BLOB-XML-FILE-DATA-LENGTH PIC S9(9) COMP-5.
  49 BLOB-XML-FILE-FILE-OPTION PIC S9(9) COMP-5.
  49 BLOB-XML-FILE-NAME PIC X(255).             
01  CLOB-XML-FILE USAGE IS SQL
    TYPE IS XML AS CLOB-FILE.
01  CLOB-XML-FILE.                              
  49 CLOB-XML-FILE-NAME-LENGTH PIC S9(9) COMP-5 SYNC.
  49 CLOB-XML-FILE-DATA-LENGTH PIC S9(9) COMP-5.
  49 CLOB-XML-FILE-FILE-OPTION PIC S9(9) COMP-5.
  49 CLOB-XML-FILE-NAME PIC X(255).             
01  DBCLOB-XML-FILE USAGE IS SQL
    TYPE IS XML AS DBCLOB-FILE.
01  DBCLOB-XML-FILE.                                   
  49 DBCLOB-XML-FILE-NAME-LENGTH PIC S9(9) COMP-5 SYNC.
  49 DBCLOB-XML-FILE-DATA-LENGTH PIC S9(9) COMP-5.     
  49 DBCLOB-XML-FILE-FILE-OPTION PIC S9(9) COMP-5.     
  49 DBCLOB-XML-FILE-NAME PIC X(255).                  
注 :
  1. 長さが 32767 バイトより大きい XML AS BLOB または XML AS CLOB ホスト変数について、 Db2 は、32767 バイト以下 のホスト言語宣言を複数作成します。
  2. 長さが 32767 (2 バイト文字単位) より大きい XML AS DBCLOB ホスト変数について、 Db2 は、 32767 (2 バイト文字単位) 以下のホスト言語宣言を複数作成します。

PL/I における XML ホスト変数の宣言

PI/I に対して生成される宣言は、 Db2 プリコンパイラー を使用するか、Db2 コプロセッサーを使用するかによって異なります。

以下の表は、 いくつかの代表的な XML タイプについて Db2 プリコンパイラーで生成される PL/I による宣言を示しています。

表 4. PL/I 変数宣言の例
プログラムで宣言する変数 Db2 プリコンパイラーが生成する変数
DCL BLOB_XML
  SQL TYPE IS XML AS BLOB (1M);
DCL                                            
   1   BLOB_XML,                               
      2   BLOB_XML_LENGTH BIN FIXED(31),       
      2   BLOB_XML_DATA,1
        3   BLOB_XML_DATA1 (32) CHAR(32767),
        3   BLOB_XML_DATA2 CHAR(32);        
DCL CLOB_XML
  SQL TYPE IS XML AS CLOB (40000K);
DCL                                            
   1   CLOB_XML,                               
      2   CLOB_XML_LENGTH BIN FIXED(31),       
      2   CLOB_XML_DATA,1                       
        3   CLOB_XML_DATA1 (1250) CHAR(32767),
        3   CLOB_XML_DATA2 CHAR(1250);      
DCL DBCLOB_XML
  SQL TYPE IS XML AS DBCLOB (4000K);
DCL                                                  
   1   DBCLOB_XML,                                   
      2   DBCLOB_XML_LENGTH BIN FIXED(31),           
      2   DBCLOB_XML_DATA,2                           
        3   DBCLOB_XML_DATA1 (250  ) GRAPHIC(16383), 
        3   DBCLOB_XML_DATA2 GRAPHIC(250);           
DCL BLOB_XML_FILE
  SQL TYPE IS XML AS BLOB_FILE;
DCL                                                       
   1   BLOB_XML_FILE,                                     
      2   BLOB_XML_FILE_NAME_LENGTH BIN FIXED(31) ALIGNED,
      2   BLOB_XML_FILE_DATA_LENGTH BIN FIXED(31),        
      2   BLOB_XML_FILE_FILE_OPTIONS BIN FIXED(31),       
      2   BLOB_XML_FILE_NAME CHAR(255);                   
DCL CLOB_XML_FILE
  SQL TYPE IS XML AS CLOB_FILE;
DCL                                                        
   1   CLOB_XML_FILE,                                      
      2   CLOB_XML_FILE_NAME_LENGTH BIN FIXED(31) ALIGNED, 
      2   CLOB_XML_FILE_DATA_LENGTH BIN FIXED(31),         
      2   CLOB_XML_FILE_FILE_OPTIONS BIN FIXED(31),        
      2   CLOB_XML_FILE_NAME CHAR(255);                    
DCL DBCLOB_XML_FILE SQL TYPE IS XML AS 
  DBCLOB_FILE;
DCL                                                         
   1   DBCLOB_XML_FILE,                                     
      2   DBCLOB_XML_FILE_NAME_LENGTH BIN FIXED(31) ALIGNED,
      2   DBCLOB_XML_FILE_DATA_LENGTH BIN FIXED(31),        
      2   DBCLOB_XML_FILE_FILE_OPTIONS BIN FIXED(31),       
      2   DBCLOB_XML_FILE_NAME CHAR(255);                   
注 :
  1. 長さが 32767 バイトより大きい XML AS BLOB または XML AS CLOB ホスト変数 について、Db2 は、 以下のようにホスト言語宣言を作成します。
    • XML の長さが 32767 バイトより大きく、32767 で割り切れる場合、 Db2 は、 32767 バイト・ストリングの配列を作成します。配列の次元は、length/32767 です。
    • XML の長さが 32767 バイトより大きく、32767 で割り切れない場合、 Db2 は、2 つの宣言を作成 します。最初の宣言は、32767 バイト・ストリングの配列で、配列 n の次元は、length/32767 です。2 番目の宣言は、長さが length-n*32767 の文字ストリングです。
  2. 長さが 16383 (2 バイト文字単位) より大きい XML AS DBCLOB ホスト変数について、 Db2 は、 以下のようにホスト言語宣言を作成します。
    • XML の長さが 16383 文字より大きく、16383 で割り切れる場合、 Db2 は、 16383 文字ストリングの配列を作成します。配列の次元は、length/16383 です。
    • XML の長さが 16383 文字より大きく、16383 で割り切れない場合、 Db2 は、2 つの宣言を作成 します。最初の宣言は、16383 バイト・ストリングの配列で、配列 m の次元は、length/16383 です。2 番目の宣言は、長さが length-m*16383 の文字ストリングです。