TDVでは、データソースに接続するための仕組みとして、各種データソースに対応したアダプタが提供されています。
本記事はアダプタ全般について説明するものです。
TDVでは、大きく分けて以下の３種類のアダプタが提供されています。
- TDVネイティブアダプタ
- CData社提供アダプタ (TIBCO Supported)
- CData社提供アダプタ (CData Supported)
TDVネイティブアダプタ
TIBCO社より提供されているTDV標準のアダプタです。
TDV Server をインストールした時点で利用することができます。
JDBCドライバを利用するアダプタについては、JDBCドライバ（jarファイル）を個別に入手し、以下の所定のフォルダに配置したうえで、TDV Serverサービスを再起動する必要があります。[TDVインストールフォルダ]\conf\adapters\system\[アダプタ名]
アダプタの動作に必要なドライバが未配置の場合は、データソース作成時にStudio上で警告が表示されます。
※PostgreSQLアダプタはインストーラにJDBCドライバが同梱されているため、手動配置する必要はありません。
Studio オンラインヘルプの以下ページに一覧が記載されています。
このアダプタは以下の要素により構成されます。
設定ファイル
以下の2種類の設定ファイルを利用します。
XMLファイル
XML形式で定義されたアダプタに関する設定ファイルです。
[TDVインストールフォルダ]\conf\adapters\system\[アダプタ名]に格納されています。
capabilitiesファイル
データソース側に関数の実行をプッシュダウンさせるための、TDV側の関数とデータソース側の関数の対応関係が定義されている設定ファイルです。
[TDVインストールフォルダ]\apps\dlm\cis_ds_[アダプタ名]\confに格納されています。
JDBCドライバ
利用者によってTDV Serverインストール後に利用者によって配置されるJDBCドライバ（jarファイル）を利用します。
格納場所は[TDVインストールフォルダ]\conf\adapters\system\[アダプタ名]です。
例）ojdbc8.jar
追加コンポーネント
以下のパスに存在する、クラス・ファイルを含む各アダプタのデフォルトのコンポジット・ドライバ（TIBCOにより提供されているTDVネイティブアダプタ毎に用意されているjarファイル）などの追加コンポーネントを利用します。[TDVインストールフォルダ]\apps\dlm\cis_ds_[アダプタ名]\lib
例）cis_ds_oracle.jar
基本的に利用者が意識する必要はありません。
CData社提供アダプタ (TIBCO Supported)
CData社により提供されているアダプタです。
TDV Server をインストールした時点で利用することができます。
アダプタが利用するJDBCドライバもすでにデプロイされているため、JDBCドライバを別途配置する必要はありません。
一方で、アダプタそのものはCData社のTIBCO DV Adapters上のTIBCO Supported Adaptersでも提供されており、メールアドレスをご登録頂いたうえでダウンロードし、TDV Serverにデプロイすることで、最新版のアダプタを利用することも可能です。
その際には、既存のアダプタを一度アンデプロイし、ダウンロードした最新のアダプタをデプロイすることになります。
詳細は各アダプタのヘルプをご確認ください。（例：TDV Adapter for Amazon Redshift > Getting Started > Deploying the Amazon Redshift Adapter）
Studio オンラインヘルプの サポートされている高度なデータソースアダプターに一覧が記載されています。
ただし、Salesforce with SSO アダプタについてはv8.5.5の時点で記載がありませんので、ご注意ください。
設定ファイル
YAMLファイルを利用します。
格納場所は [TDVインストールフォルダ]\packages\[アダプタ名]\confです。
例）Salesforce_properties.yaml
JDBCドライバ
以下のパスに配置されるJDBCドライバ（jarファイル）を利用します。[TDVインストールフォルダ]\packages
例）Salesforce_1.jar
追加コンポーネント
追加コンポーネントはありません。
CData社提供アダプタ (CData Supported)
CData社により提供されているアダプタです。
TDV Server をインストールした時点では利用することはできません。
利用する場合は、CData社のTIBCO DV Adapters上のAdditional Adapters for TIBCO DV (CData Supported)にリストされているアダプタをメールアドレスをご登録頂いたうえでダウンロードし、TDV Serverにデプロイ頂く必要があります。
設定ファイル
CData社提供アダプタ (TIBCO Supported) と同様に、 YAMLファイルを利用します。
格納場所は [TDVインストールフォルダ]\packages\[アダプタ名]\confです。
例）Box_properties.yaml
JDBCドライバ
CData社提供アダプタ (TIBCO Supported) と同様に、以下のパスに配置されるJDBCドライバ（jarファイル）を利用します。[TDVインストールフォルダ]\packages
例）Box_1.jar
追加コンポーネント
追加コンポーネントはありません。
TDVアップグレード時におけるアダプタの扱い
アーカイブを仕様したTDVのアップグレード時において、アダプタがどのようにして扱われるのか（移行前後で何が引き継がれるのか？ など）を説明します。
ここでの「アップグレード」は、TDVのアップグレード用アーカイブファイル（zipファイル）や、アップグレードスクリプトを利用することで既存環境をそのまま新バージョンにアップグレードすることを指します。
旧環境を残し、そこからエクスポートしたCARファイル（完全サーバーバックアップ）を新環境にインポートする方式とは異なりますので、ご注意ください。
TDVネイティブアダプタの場合
| 項目 | アップグレード時の扱い |
|---|---|
| XMLファイル |
引き継がれます。 |
| capabilitiesファイル |
引き継がれません。 |
|
JDBCドライバ |
引き継がれます。 |
| 追加コンポーネント |
引き継がれません。 |
CData社提供アダプタ (TIBCO Supported) の場合
以下のとおり、すべて引き継がれません。
アップグレード作業時にTDVインストールフォルダに配置するアーカイブを展開した時点で、autodeploy_ds_adaptersフォルダに全アダプタのJARファイル（JDBCドライバ）が格納され、再起動と同時にアダプタが更新されます（更新前とJARファイルが異なる場合のみ）。
| 項目 | アップグレード時の扱い |
|---|---|
| 設定ファイル（YAML） |
引き継がれません。 |
| JDBCドライバ | 引き継がれません。 厳密には、アップグレード後のTDV Server上のものが利用されます。 |
CData社提供アダプタ (CData Supported) の場合
| 項目 | アップグレード時の扱い |
|---|---|
| 設定ファイル（YAML） |
引き継がれます。 |
| JDBCドライバ | 引き継がれます。 |
CARファイルによるデータ移行時におけるアダプタの扱い
TDV Serverをアップグレードする場合や何らかの事情により環境を移設する場合に、新しいバージョンのTDV Serverを同一マシン上や別のマシン上に新規にインストールし、事前にエクスポートしておいたCARファイルをインポートするといった方法により実施することができます。
ここでは、CARファイルによるデータ移行において、アダプタがどのようにして扱われるのか（移行前後で何が引き継がれるのか？ など）を説明します。
前提条件
本章での説明は、以下いずれかの条件を満たすことを前提とします。
- 完全サーバーバックアップによりCARファイルを作成
- Studio上のGUIで作成する場合は「カスタムJar」にチェックを入れること
- 移行対象アダプタを利用するデータソースオブジェクトを含む一部のリソースを対象としてCARファイル
- 例）
/shared/sample配下をエクスポートした結果作成されたCARファイル - Studio上のGUIで作成する場合は「カスタムJar」にチェックを入れること
- 例）
移行元、移行先いずれのTDV Serverにも存在するTDVネイティブアダプタの場合
| 項目 | データ移行時の扱い |
|---|---|
| XMLファイル |
引き継がれます。 |
| capabilitiesファイル |
引き継がれません。 |
|
JDBCドライバ |
引き継がれます。 |
| 追加コンポーネント |
引き継がれません。 |
移行元、移行先いずれのTDV Serverにも存在するCData社提供アダプタ (TIBCO Supported) の場合
| 項目 | データ移行時の扱い |
|---|---|
| 設定ファイル（YAML） |
引き継がれません。 |
| JDBCドライバ | 引き継がれません。 厳密には、移行先のTDV Server上のものが利用されます。 |
移行元の環境においてデプロイ済みの CData社提供アダプタ (CData Supported) の場合
アダプタそのものが引き継がれません。
したがって、 移行先TDV Serverにおいても、移行元と同様に CData社のTIBCO DV Adapters上のAdditional Adapters for TIBCO DV (CData Supported)にリストされているアダプタをメールアドレスをご登録頂いたうえでダウンロードし、TDV Serverにデプロイ頂く必要があります。
また、必要に応じて、設定ファイルも変更する必要があります。
CData社提供アダプタ (TIBCO Supported) における注意点
上記「移行元、移行先いずれのTDV Serverにも存在するCData社提供アダプタ (TIBCO Supported) の場合」に対する補足です。
TDV Serverのアップグレード時に利用するService Packアーカイブ（TIB_tdv_server_8.6.1_all.zipなど）展開後に[TDVインストールフォルダ]\packages\autodeploy に配置されたjarファイル群は、TDV Serverサービス再起動後に、[TDVインストールフォルダ]\packages直下の対応するjarファイルへ置き換えられます。ただし、すべての場合ではなく、元々[TDVインストールフォルダ]\packages直下に存在していたjarファイルが、[TDVインストールフォルダ]\packages\autodeploy配下のjarファイルと異なる場合のみ置き換えられます。
これにより、移行元のTDV Serverでは最新のアダプタ（例えば、CData社のTIBCO DV Adaptersから最新版をダウンロードし既存アダプタをアンデプロイして置き換えた v22.0）を利用していたが、移行先のTDV ServerではインストーラやService Packアーカイブによってデプロイされるアダプタが最新版に比べると古い（例えば、v21.0）ために、思わぬトラブルが生じる可能性もあります。
このような事態を回避するためにも、最新版の CData社提供アダプタ (TIBCO Supported) を利用する場合は、Service Pack適用後やアップグレード作業後に最新版のCData社アダプタをダウンロードしデプロイしておくことを推奨します。