Squirrel SQL Client からZuora データに連携

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for Zuora を使用して、Squirrel SQL Client などのツールでZuora へのクエリを実行できます。この記事では、JDBC data source for Zuora を作成し、クエリを実行します。

JDBC Driver for Zuora を追加する

以下のステップに従ってドライバーJAR を追加します。

1. Squirrel SQL で［Windows］->［View Drivers］と進みます。
2. プラスアイコンをクリックし、［Add Driver］ウィザードを開きます。
3. ［Name］ボックスで、CData JDBC Driver for Zuora のようなドライバーのわかりやすい名前を入力します。
4. ［Example URL］ボックスで、jdbc:zuora: と入力します。
5. ［Extra Class Path］タブで［Add］をクリックします。
6. 表示される［file explorer］ダイアログで、インストールディレクトリのlib サブフォルダにあるドライバーのJAR ファイルを選択します。
7. ［List Drivers］をクリックして［Class Name］メニューにドライバーのクラス名(cdata.jdbc.zuora.ZuoraDriver) を入力します。

接続プロパティを定義する

以下のステップに従って、接続プロパティをドライバーエイリアスに保存します。

1. ［Windows］->［View Aliases］と進みます。
2. エイリアスが一覧表示されているペインで、プラスアイコンをクリックします。

3. 表示される［Add Alias］ウィザードで、JDBC ドライバーには以下のフィールドが要求されます。

   • Name:CData Zuora Source のようなエイリアスの名前を入力します。
   • Driver:CData JDBC Driver for Zuora を選択します。
   • URL:jdbc:zuora: と入力します。
4. 追加のプロパティを定義する場合は、［Properties］をクリックします。
5. 表示されるダイアログの［Driver properties］タブで、［Use driver properties］のチェックボックスを選択します。
6. ［Specify］カラムで必要な接続プロパティのチェックボックスを選択します。

   Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。

   Tenant プロパティの設定

   プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。
   • USProduction：リクエストはhttps://rest.zuora.com に送信されます。
   • USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
   • USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
   • EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
   • EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。

   デフォルトではUSProduction テナントを使用します。

   Zuora サービスの選択

   データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。

   DataQuery

   データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。

   制限

   • フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
   • 出力レコードの最大数： 100,000
   • テナントごとの、実行用に送信される同時クエリの最大数： 5
   • テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
   • 1時間単位での、各クエリの最大処理時間： 1
   • GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
   • Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

   AQuADataExport

   AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。

   制限

   • AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
   • 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。

   以下は一般的な接続文字列です。

   jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH
7. ［OK］をクリックし、表示されるダイアログで［connect］をクリックして接続を確認します。

スキーマを検出しZuora データをクエリする

メタデータが読み込まれると、Zuora データソースの新しいタブが表示されます。［Objects］サブタブでは、使用可能なテーブルやビューなどのスキーマ情報を見つけることができます。

テーブルデータを表示するには［Objects］タブでテーブルを選択します。その後、テーブルデータが［Content］タブのグリッドに読み込まれます。

SQL クエリを実行するには、［SQL］タブにクエリを入力し、［Run SQL］(ランナーアイコン)をクリックします。例：