ETL ツールのEmbulk を使ってPipedrive データをDB にロードする方法

こんにちは！リードエンジニアの杉本です。

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

Embulk でPipedrive のデータをロード

• CData JDBC Driver for Pipedrive をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
  C:\Program Files\CData\CData JDBC Driver for Pipedrive 2019J\lib\cdata.jdbc.pipedrive.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 ファイルを作成し、Pipedrive -> MySQL のジョブを作成します。pipedrive-mysql.yml というファイル名で、以下の内容で作成しました。
in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Pipedrive 2024J\lib\cdata.jdbc.pipedrive.jar driver_class: cdata.jdbc.pipedrive.PipedriveDriver url: jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken; table: "Deals" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Deals" mode: insert
• JDBC URL の内容は、ご利用の環境や資格情報を入力してください。

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

  Pipedrive への接続に使用できる認証方法は、Basic およびOAuth です。

  Basic

  API トークンの取得から始めます。
  1. PipeDrive の右上にあるアカウント名をクリックします。
  2. 会社設定をクリックし、続いてPersonal Preferences -> API -> Generate Token をクリックします。
  3. API トークンを控えておきます。
  4. CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。

  以下を設定してPipedrive へ認証します。

  • APIToken：控えておいたAPI トークンに設定。
  • CompanyDomain：控えておいた開発者サンドボックスURL の会社ドメインに設定。
  • AuthScheme：Basic に設定。

  API トークンは、PipeDrive の右上にあるアカウント名 -> 会社設定 -> Personal preferences -> API に移動して確認できます。

  OAuth

  ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

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

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

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

おわりに

CData JDBC Driver for Pipedrive をEmbulk で使うことで、Pipedrive と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。