各製品の資料を入手。
詳細はこちら →ETL ツールのEmbulk を使ってZoho Books のデータをDB にロードする方法
OSS のETL ツールEmbulk のJDBC Plugin を使って、Zoho Books のデータを簡単にDB に同期する方法をご紹介します。
最終更新日:2023-10-13
この記事で実現できるZoho Books 連携のシナリオ
こんにちは!リードエンジニアの杉本です。
Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for ZohoBooks を使って、Zoho Books のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。
Embulk でZoho Books のデータをロード
- CData JDBC Driver for ZohoBooks をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
-
以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
C:\Program Files\CData\CData JDBC Driver for ZohoBooks 2019J\lib\cdata.jdbc.zohobooks.jar 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。
https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbcインストール用のコマンドはこちら:
embulk gem install embulk-input-jdbc
今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。
https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysqlコマンドはこちら。
embulk gem install embulk-output-mysql
- config ファイルを作成し、Zoho Books -> MySQL のジョブを作成します。zohobooks-mysql.yml というファイル名で、以下の内容で作成しました。
- JDBC URL の内容は、ご利用の環境や資格情報を入力してください。
Zoho Books 接続プロパティの取得・設定方法
以下の接続プロパティを使用して、取得されるZoho Books データを正確に絞り込むことができます。
- Region:サーバーURL のトップレベルドメイン(TLD)。アカウントが米国以外のドメインにある場合は、リージョンを適宜変更してください。
- OrganizationId(オプション):接続先の特定のZoho Books 組織に関連付けられたID。
- Organization Id の値が接続文字列で指定されていない場合、ドライバーは利用可能なすべての組織を自動的に取得し、最初のOrganization Id をデフォルトとして選択します。
Zoho Books への認証
Zoho Books はOAuth 認証標準を使用します。詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。
- テーブル名は取得したいテーブル名を入れます。
- これで準備完了です。あとは「embulk run」で実行するだけです。
- 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for ZohoBooks 2025J\lib\cdata.jdbc.zohobooks.jar
driver_class: cdata.jdbc.zohobooks.ZohoBooksDriver
url: jdbc:zohobooks:OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;CallbackURL=https://localhost:33333;OrganizationId=MyOrganizationId;InitiateOAuth=REFRESH
table: "INVOICES"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "INVOICES"
mode: insert
embulk run zohobooks-mysql.yml
クエリ条件でフィルタリングしたデータのロード
ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for ZohoBooks 2019J\lib\cdata.jdbc.zohobooks.jar
driver_class: cdata.jdbc.zohobooks.ZohoBooksDriver
url: jdbc:zohobooks:OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;CallbackURL=https://localhost:33333;OrganizationId=MyOrganizationId;InitiateOAuth=REFRESH
query: "SELECT InvoiceId, InvoiceNumber FROM INVOICES WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "INVOICES"
mode: insert
おわりに
CData JDBC Driver for ZohoBooks をEmbulk で使うことで、Zoho Books と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。