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

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

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

はじめに

---

Xero への JDBC 接続を設定

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

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

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

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

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

java -jar cdata.jdbc.xero.jar

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

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

jdbc:xero:

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

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

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

1. Embulk にJDBC 入力プラグインをインストールします。
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

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 を使用してXero のデータをMySQL にロードする準備が整いました。

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.xero.jar
	driver_class: cdata.jdbc.xero.XeroDriver
	url: jdbc:xero:
	table: "Items"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Items"
	mode: insert

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

embulk run xero-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.xero.jar
	driver_class: cdata.jdbc.xero.XeroDriver
	url: jdbc:xero:
	query: "SELECT Name, QuantityOnHand FROM Items WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Items"
	mode: insert

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

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