各製品の資料を入手。
詳細はこちら →
製品をチェック
ETL ツールのEmbulk を使ってFreshdesk のデータをDB にロードする方法
OSS のETL ツールEmbulk のJDBC Plugin を使って、Freshdesk のデータを簡単にDB に同期する方法をご紹介します。
最終更新日：2023-10-13
この記事で実現できるFreshdesk 連携のシナリオ
こんにちは！リードエンジニアの杉本です。
Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for FreshDesk を使って、Freshdesk のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。
Embulk でFreshdesk のデータをロード
- CData JDBC Driver for FreshDesk をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
-
以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
C:\Program Files\CData\CData JDBC Driver for FreshDesk 2019J\lib\cdata.jdbc.freshdesk.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 ファイルを作成し、Freshdesk -> MySQL のジョブを作成します。freshdesk-mysql.yml というファイル名で、以下の内容で作成しました。
- JDBC URL の内容は、ご利用の環境や資格情報を入力してください。
FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。
- Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
- APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。
- テーブル名は取得したいテーブル名を入れます。
- これで準備完了です。あとは「embulk run」で実行するだけです。
- 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for FreshDesk 2025J\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 run freshdesk-mysql.yml
クエリ条件でフィルタリングしたデータのロード
ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for FreshDesk 2019J\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 と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。
関連コンテンツ
