DbVisualizer でIBM Cloud Object Storage データに連携しクエリを作成

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for IBMCloudObjectStorage は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでIBM Cloud Object Storage データへの接続を提供します。この記事では、DbVisualizer からIBM Cloud Object Storage データに接続する方法、およびtable エディタを使ってIBM Cloud Object Storage をロード、する方法を説明します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. IBM Cloud Object Storage をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにIBM Cloud Object Storage データを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてIBM Cloud Object Storage の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

IBM Cloud Object Storage データの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからIBM Cloud Object Storage データに接続します。

1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
2. 「」ボタンをクリックして新しくドライバーを作成します。
3. テンプレートは「Custom」を選択します。
4. Driver Settings タブで：
   • Name をわかりやすい名前に設定します（例：CData IBM Cloud Object Storage Driver）。
   • URL Format をjdbc:ibmcloudobjectstorage: に設定します。
   • Driver artifacts and jar files (jars are loaded in order from top) セクションで：
     1. 「」ボタンをクリックして、「Add Files」に進みます。
     2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for IBM Cloud Object Storage XXXX\）の「lib」フォルダに移動します。
     3. JAR ファイル（cdata.jdbc.IBMCloudObjectStorage.jar）を選択して「Open」をクリックします。
5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:ibmcloudobjectstorage: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     Cloud Object Storage 接続プロパティの取得・設定方法

     Cloud Object Storage に接続する前に、Cloud Object Storage インスタンスを登録してCloud Object Storage API キーとCRN を取得していきます。

     Cloud Object Storage の新規インスタンスの登録

     IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。

     1. IBM Cloud アカウントにログインします。
     2. Cloud Object Storage ページに移動して、インスタンス名を指定して「作成」をクリックします。Cloud Object Storage の新規インスタンスにリダイレクトされます。

     API キー

     API キーは以下の手順で取得できます。

     1. まずは、IBM Cloud アカウントにログインします。
     2. API キーページに移動します。
     3. 中央右隅のIBM Cloud APIキーの作成 をクリックして、新しいAPI キーを作成します。
     4. ポップアップウィンドウが表示されたら、API キーの名前を指定して作成をクリックします。ダッシュボードからはアクセスできなくなるため、API Key を控えておきましょう。

     Cloud Object Storage CRN

     デフォルトでは、CData 製品はCloud Object Storage CRN を自動で取得します。ただし、複数のアカウントがある場合は、CloudObjectStorageCRN を明示的に指定する必要があります。この値は、次の2つの方法で取得できます。

     • Services ビューをクエリする。これにより、IBM Cloud Object Storage インスタンスとそれぞれのCRN がリストされます。
     • IBM Cloud で直接CRN を見つける。これを行うには、IBM Cloud のダッシュボードに移動します。リソースリストで、ストレージからCloud Object Storage リソースを選択してCRN を取得します。

     IBM Cloud Object Storage への接続

     これで準備は完了です。以下の接続プロパティを設定してください。

     • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 認証を繰り返す必要がなく、さらに自動でアクセストークンを設定できます。
     • ApiKey：セットアップ中に控えたAPI キーを指定。
     • CloudObjectStorageCRN（オプション）：控えておいたCloud Object Storage のCRN に設定。Cloud Object Storage アカウントが複数ある場合のみ設定する必要があります。

     プロパティを設定したら、これで接続設定は完了です。

     組み込みの接続文字列デザイナー

     JDBC URL の作成の補助として、IBM Cloud Object Storage JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     java -jar cdata.jdbc.ibmcloudobjectstorage.jar

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

     一般的な接続文字列は次のとおりです。

     jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
   • NOTE：IBM Cloud Object Storage は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
3. 「Connection」タブで「Connect」をクリックします。

IBM Cloud Object Storage JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに