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

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

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

Freshdesk への JDBC 接続を設定

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

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

FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。

• Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
• APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。

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

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

java -jar cdata.jdbc.freshdesk.jar

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

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

jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.freshdesk.jar
	driver_class: cdata.jdbc.freshdesk.FreshDeskDriver
	url: jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
	table: "Tickets"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Tickets"
	mode: insert

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

embulk run freshdesk-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.freshdesk.jar
	driver_class: cdata.jdbc.freshdesk.FreshDeskDriver
	url: jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;
	query: "SELECT Id, Name FROM Tickets WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Tickets"
	mode: insert

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

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