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

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

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

Zendesk への JDBC 接続を設定

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

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

Zendesk 接続プロパティの取得・設定方法

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

1. Token アクセスを有効にします。
2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。

その他の認証方法についてはヘルプドキュメントを参照してください。

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

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

java -jar cdata.jdbc.zendesk.jar

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

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

jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.zendesk.jar
	driver_class: cdata.jdbc.zendesk.ZendeskDriver
	url: jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
	table: "Tickets"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Tickets"
	mode: insert

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

embulk run zendesk-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.zendesk.jar
	driver_class: cdata.jdbc.zendesk.ZendeskDriver
	url: jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;
	query: "SELECT Id, Subject FROM Tickets WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Tickets"
	mode: insert

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

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