DB2 for IBM i Advanced Configuration - CData Arc Documentation

XML Models

DB2 for IBM i コネクタは、CData Arc 内で DB2 for IBM i のテーブルを XML としてモデル化します。モデル化は次の構造に従います。

親要素は、挿入先のテーブルを識別します。
各子要素は、対象テーブルのカラムに対応します。

これにより、XML 要素と DB2 for IBM i の値とのつながりが確立され、コネクタは受信した XML ドキュメントから値を読み取り、それを INSERT または UPDATE クエリで使用できるようになります。テーブルの XML モデルは、設定ペインの上部にある </> Code をクリックすると確認できます。次の XML は、XML 要素 <Account> としてモデル化された Account という名前のテーブルの簡略化されたモデル例です。

<Items>
    <Account action="upsert">
        <Id key="true" />
        <account_c />
        <AccountNumber />
        <AccountSource />
    </Account>
</Items>

上記の例では、Id、account_c、AccountNumber、AccountSource は Account テーブルのカラムです。コネクタがこの構造に一致する XML ファイルを処理すると、その XML の値が自動的に Account テーブルに挿入されます。コネクタが Account テーブルをクエリすると、この構造に一致する XML を出力します。

Batching Input

Batching Output

Child Tables

Child Table XML

親テーブルと子テーブルに挿入する場合、入力マッピングの XML 構造は多層的になります。次の XML スニペットは、外部キーで関連付けられた2つのテーブルの入力マッピング例です。

<Account action="upsert">
    <Id key="true" />
    <account_c />
    <AccountNumber />
    <AccountSource />
    <AccountPartner>
        <Id key="true" />
        <AccountFromId ref="@Id" />
        <IsPrimary />
        <OpportunityId />
        <Role />
    </AccountPartner>
</Account>

上記の例では、Account が親テーブルで、AccountPartner が子テーブルです。DB2 for IBM i コネクタがこの構造に一致する入力 XML ファイルを処理すると、両方のテーブルを更新し、2つのレコードを関連付けるキーが同一になるようにします。

Using the ref Attribute

子テーブルの一部のカラムには ref タグが付けられています。このタグは、これらのカラムが親テーブルの主キーに対応していることを示します。コネクタは、親テーブルへの挿入を行った後、子テーブルへの挿入を行う前に、たった今挿入したレコードの主キーを親テーブルにクエリします。コネクタは、子テーブルに挿入する際にこの値を使用します。これは、親テーブルの主キーが DB2 for IBM i によって生成される場合に便利です。この場合、このカラムは入力 XML として渡されないため、コネクタは親テーブルにレコードを挿入するまでそのカラムの値を知ることができません。 XML モデルにおいて、ref 属性は、カラムが後で参照できること、またはカラムの値がマッピング内の別のカラムから読み取られるべきことを示します。DB2 for IBM i によって生成されるカラムの値を参照するには、カラム要素に予約値 LAST_INSERT_ID を設定した ref 属性を含める必要があります。

<Item action="upsert">
    <Id key="true" upsert="id" ref="@@LAST_INSERT_ID" />

これは、id の値が挿入後に取得され、後で（通常は子テーブルで）参照できることを示します。この値を後で参照するには、ref 要素に該当するカラムの名前を設定します。

<id key="true" ref="@id" />

上記の例では、id は親テーブルの主キーの名前であり、子テーブルのカラムの名前でもあります。この ref 構文は、挿入後に親テーブルから id を取得し、取得した値を子テーブルの id カラムとして使用するようコネクタに指示します。

Selecting From Child Tables

Only Process New or Changed Records

Using a Last Modified Column

Using a Custom Column

Pre-Processing and Post-Processing Queries

In Upsert Mappings

Upsert マッピングでは、テーブルにすべてのレコードがアップサートされる前または後に自動的に実行されるクエリを発行できます。この機能を設定するには、まず Upsert Configuration ペインで </> Code をクリックします。

これにより、テーブルマッピングの高度な設定を編集できるテキストエディタが開きます。エディタ内のテキストは、次のスニペットのようになります。

<Items>
    <Names table="`dbo`.`Names`" action="upsert">
        <ID key="true" />
        <Name />
        …
    </Names>
</Items>

テーブルにカラムを追加する前または後にクエリを発行するには、次の属性を持つ要素を定義します。

requireInput: false に設定します。この属性値は、入力ファイル内に一致する入力要素がなくてもクエリを発行するようコネクタに指示します。
insertQuery: UPSERT クエリの前または後に実行したいクエリを格納します。
table（任意）: 追加クエリの対象にしたいテーブルの名前を設定します。（以下の例では、テーブル名は updateTable です。）マッピングのルートレベル、つまり <Items> 要素の子としてクエリを発行する場合、この属性は必要ありません。別のテーブルの子としてクエリを発行する場合は、table 属性を設定することで、そのクエリがそのテーブルのカラムと区別されるようになります。

新しく定義した要素を、実行したいタイミングに応じて UPSERT クエリの前または後に配置します。次の例では、<runFirst> 要素が、テーブルへの UPSERT リクエストの前にクエリ EXEC [dbo.FlushTemp] を実行します。

<Items>
    <runFirst table="updateTable" insertQuery="EXEC [dbo].[FlushTemp]" requireInput="false" />
    <Names table="`dbo`.`Names`" action="upsert">
        <ID key="true" />
        <Name />
        …
    </Names>
</Items>

次の例では、<runLast> 要素が、テーブルへのすべての UPSERT リクエストが完了した後にクエリ EXEC [dbo].[CommitTemp] を実行します。

<Items>
    <Names table="`dbo`.`Names`" action="upsert">
        <ID key="true" />
        <Name />
        …
    </Names>
    <runLast table="updateTable" insertQuery="EXEC [dbo].[CommitTemp]" requireInput="false" />
</Items>

要素名 runFirst および runLast はプレースホルダです。要件に合わせて変更できます。

Upsert マッピングにおける前処理クエリおよび後処理クエリは、クエリ内にハードコードされていない入力要素を受け付けず、また出力データを生成しません。

In Select Mappings

Select マッピングでは、対象テーブルへのクエリ発行の前後に自動的に実行されるクエリを発行できます。この機能を設定するには、まず Select Configuration ペインで </> Code をクリックします。

これにより、テーブルマッピングの高度な設定を編集できるテキストエディタが開きます。テーブルにカラムを追加する前または後にクエリを発行するには、次の属性を持つ要素を定義します。

outputResult: false に設定します。この属性値は、クエリの結果として出力ファイルにデータを返さないようコネクタに指示します。
selectQuery: SELECT クエリの前または後に実行したいクエリを格納します。
table（任意）: 追加クエリの対象にしたいテーブルの名前を設定します。（以下の例では、テーブル名は selectTable です。）マッピングのルートレベル、つまり <Items> 要素の子としてクエリを発行する場合、この属性は必要ありません。別のテーブルの子としてクエリを発行する場合は、table 属性を設定することで、そのクエリがそのテーブルのカラムと区別されるようになります。

新しく定義した要素を、実行したいタイミングに応じて SELECT クエリの前または後に配置します。次の例では、<runFirst> 要素が、テーブルに対して SELECT クエリが発行される前にクエリ EXEC [dbo].[prepTable] を実行します。

<Items>
    <runFirst table="selectTable" selectQuery="EXEC [dbo].[prepTable]" outputResult="false" />
    <Names table="`dbo`.`Names`" action="select">
        <ID key="true" />
        <Name />
        …
    </Names>
</Items>

次の例では、<runLast> 要素が、テーブルに対して SELECT クエリおよびすべての子クエリが発行された後にクエリ EXEC [dbo].[cleanTable] を実行します。

<Items>
    <Names table="`dbo`.`Names`" action="select">
        <ID key="true" />
        <Name />
        …
    </Names>
    <runLast table="selectTable" selectQuery="EXEC [dbo].[cleanTable]" outputResult="false" />
</Items>

要素名 runFirst および runLast はプレースホルダです。要件に合わせて変更できます。

Select マッピングにおける前処理クエリおよび後処理クエリは、クエリ内にハードコードされていない入力要素を受け付けません。

XML Attributes

Table Attributes

allColumns

insertQuery

outputResult

processChangesOnly

requireInput

selectQuery

table

upsertQuery

Column Attributes

aggregate

column

id

Select マッピングでは、この属性によってカラムの値に Id マーカーが付与され、後で子クエリ内から ${#ID} という構文で参照できるようになります。これは、複数のテーブルに同名のカラムが存在し選択時にあいまいさが生じるような場面で、カラムの値を子クエリで使用したい場合に便利です。

    <Shipments table="`Shipments`" selectQuery="SELECT * FROM `Shipments`">
        <ID type="integer" key="true" id="ShipID"/>
        ...
        <ShipmentOrders table="`ShipmentOrders`" selectQuery="SELECT * FROM `ShipmentOrders` WHERE `ShipmentID` = ${ID}">
            <ID type="integer" key="true" id="ShipOrderID"/>
            ...
            <ShipmentOrderItems table="`ShipmentOrderItems`" selectQuery="SELECT * FROM `ShipmentOrderItems` WHERE `ShipmentOrderID` = ${ID}">
                <ID type="integer" key="true" id="ShipOrderItemID"/>
                ...

key

ref

Upsert マッピングでは、この属性を使って、入力 XML だけでは決定できない値をデータベースにアップサートするために指定します。これは最も一般的には、親子関係においてデータベースが生成する主キーを決定する場合や、あるテーブルが子テーブル上の外部キー参照を使用する場合に利用されます。詳細については、ref 属性の使用を参照してください。

   <Orders table="`Orders`" action="upsert">
        <ID type="integer" key="true" ref="@@LAST_INSERT_ID" />
        ...
        <OrderLines table="`OrderLines`" action="upsert">
            <ID type="integer" key="true" />
            ...
            <OrderID type="integer" ref="@ID" />
        </OrderLines>
    </Orders>

​XML Models

​Batching Input

​Batching Output

​Child Tables

​Child Table XML

​Using the ref Attribute

​Selecting From Child Tables

​Only Process New or Changed Records

​Using a Last Modified Column

​Using a Custom Column

​Pre-Processing and Post-Processing Queries

​In Upsert Mappings

​In Select Mappings

​XML Attributes

​Table Attributes

​allColumns

​insertQuery

​outputResult

​processChangesOnly

​requireInput

​selectQuery

​table

​upsertQuery

​Column Attributes

​aggregate

​column

​id

​key

​ref

​timeCheck

​type

​updateValue

XML Models

Batching Input

Batching Output

Child Tables

Child Table XML

Using the ref Attribute

Selecting From Child Tables

Only Process New or Changed Records

Using a Last Modified Column

Using a Custom Column

Pre-Processing and Post-Processing Queries

In Upsert Mappings

In Select Mappings

XML Attributes

Table Attributes

allColumns

insertQuery

outputResult

processChangesOnly

requireInput

selectQuery

table

upsertQuery

Column Attributes

aggregate

column

id

key

ref

timeCheck

type

updateValue