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

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

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

• CData JDBC Driver for FreshBooks をEmbulk と同じマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
  C:\Program Files\CData\CData JDBC Driver for FreshBooks 2019J\lib\cdata.jdbc.freshbooks.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 ファイルを作成し、FreshBooks -> MySQL のジョブを作成します。freshbooks-mysql.yml というファイル名で作成しました。

            
                in:
                    type: jdbc
                    driver_path: C:\Program Files\CData\CData JDBC Driver for FreshBooks 2019J\lib\cdata.jdbc.freshbooks.jar
                    driver_class: cdata.jdbc.freshbooks.FreshBooksDriver
                    url: jdbc:freshbooks:CompanyName=CData;Token=token;
                    table: "Clients"
                out: 
                    type: mysql
                    host: localhost
                    database: DatabaseName
                    user: UserId
                    password: UserPassword
                    table: "Clients"
                    mode: insert
            
        

• ポイントはJDBC URLです。

  FreshBooks はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。

  詳細はヘルプドキュメントの「はじめに」を参照してください。

• テーブル名は取得したいテーブル名を入れます。
• これで準備完了です。あとは「embulk run」で実行するだけです。
embulk run freshbooks-mysql.yml
• 実行後、MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

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

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL Queryを書いてもいいです。 Where句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。

        
            in:
            type: jdbc
            driver_path: C:\Program Files\CData\CData JDBC Driver for FreshBooks 2019J\lib\cdata.jdbc.freshbooks.jar
            driver_class: cdata.jdbc.freshbooks.FreshBooksDriver
            url: jdbc:freshbooks:CompanyName=CData;Token=token;
                query: "SELECT Username, Credit FROM Clients WHERE [RecordId] = 1"
            out: 
                type: mysql
                host: localhost
                database: DatabaseName
                user: UserId
                password: UserPassword
                table: "Clients"
                mode: insert
        
    

CData JDBC Driver for FreshBooks をEmbulk で使うことで、FreshBooks コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。