Embulk を使用して Zuora ののデータをデータベースにロードする方法

Jerod Johnson
Jerod Johnson
Senior Technology Evangelist
CData JDBC Driver とオープンソースのETL/ELT ツールであるEmbulk を使ってZuora のデータをデータベースにロードする方法を解説します。

Embulk はオープンソースのバルクデータローダーです。CData JDBC Driver for Zuora と組み合わせることで、Zuora から任意の同期先にデータを簡単にロードできます。この記事では、CData JDBC Driver for Zuora をEmbulk で使用してZuora のデータをMySQL データベースにロードする方法を解説します。

CData JDBC Driver は、最適化されたデータ処理機能を内蔵しており、リアルタイムのZuora のデータに対して比類のないパフォーマンスを発揮します。Zuora に対して複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Zuora にプッシュし、サポートされていない操作（SQL 関数やJOIN 操作など）は組み込みのSQL エンジンを使用してクライアント側で処理します。

Zuora への JDBC 接続を設定

Embulk でバルクロードジョブを作成する前に、JDBC Driver のJAR ファイルのインストール場所（通常はC:\Program Files\CData\CData JDBC Driver for Zuora\lib）を確認しておきます。

Embulk はJDBC 接続をサポートしているため、Zuora に簡単に接続してSQL クエリを実行できます。バルクロードジョブを作成する前に、Zuora への認証用のJDBC URL を作成します。

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 URL の作成には、Zuora JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.zuora.jar

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

以下は、Zuora への一般的なJDBC 接続文字列です。 

jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;

Embulk で Zuora ののデータをロード

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

  1. Embulk にJDBC 入力プラグインをインストールします。
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
    2. embulk gem install embulk-input-jdbc
  2. この記事では、同期先データベースとしてMySQL を使用します。出力プラグインを使用して、SQL Server、PostgreSQL、またはGoogle BigQuery を同期先として選択することもできます。
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql 
    embulk gem install embulk-output-mysql

入力プラグインと出力プラグインをインストールしたら、Embulk を使用してZuora のデータをMySQL にロードする準備が整いました。

Zuora ののデータをロードするジョブを作成

まず、Embulk で設定ファイルを作成します。ファイル名はzuora-mysql.yml のようにします。

  1. 入力プラグインのオプションには、CData JDBC Driver for Zuora、ドライバーJAR ファイルへのパス、ドライバークラス（例：cdata.jdbc.zuora.ZuoraDriver）、および上記のJDBC URL を指定します。
  2. 出力プラグインのオプションには、MySQL データベースの値と認証情報を指定します。

設定ファイルのサンプル（zuora-mysql.yml）

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.zuora.jar
	driver_class: cdata.jdbc.zuora.ZuoraDriver
	url: jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;
	table: "Invoices"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Invoices"
	mode: insert

ファイルを作成したら、Embulk ジョブを実行します。

embulk run zuora-mysql.yml

Embulk ジョブを実行すると、MySQL テーブルにZuora のデータが格納されます。

フィルタリングした Zuora ののデータをロード

テーブルから直接データをロードするだけでなく、カスタムSQL クエリを使用してロードするデータをより詳細に制御できます。また、クエリフィールドのSQL WHERE 句で最終更新カラムを設定することで、増分ロードを実行することもできます。 

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.zuora.jar
	driver_class: cdata.jdbc.zuora.ZuoraDriver
	url: jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;
	query: "SELECT Id, BillingCity FROM Invoices WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Invoices"
	mode: insert

詳細情報と無料トライアル

CData JDBC Driver for Zuora をコネクタとして使用することで、Embulk のデータロードジョブにZuora のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。

はじめる準備はできましたか？

Zuora Driver の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Zuora Icon Zuora JDBC Driver お問い合わせ

Zuora データを組み込んだパワフルなJava アプリケーションを短時間・低コストで作成して配布できます。

この記事の内容

関連記事