ETL/ELT のEmbulk を使ってFreshdesk データをDB にロードする方法

Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは、1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL/ELT ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析やビジュアライズをすることが主流になっています。Embulk には、いろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for FreshDesk を使って、Freshdesk のデータを簡単にDB にロードします。この例ではロード先のDB にはMySQL を使います。

Embulk でCData JDBC Driver for FreshDesk データをロード

• CData JDBC Driver for FreshDesk をEmbulk と同じマシンにインストールします。
• 以下のパスに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 というファイル名で作成しました。

            
                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;
                    table: "Tickets"
                out: 
                    type: mysql
                    host: localhost
                    database: DatabaseName
                    user: UserId
                    password: UserPassword
                    table: "Tickets"
                    mode: insert
            
        

• ポイントはJDBC URLです。

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

  • Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
  • APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。
• テーブル名は取得したいテーブル名を入れます。
• これで準備完了です。あとは「embulk run」で実行するだけです。
embulk run freshdesk-mysql.yml
• 実行後、MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

クエリ条件でフィルタリングしたデータのロード

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL Queryを書いてもいいです。 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日の無償評価版をお試しください。