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

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

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

Pipedrive への JDBC 接続を設定

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

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

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

Pipedrive には、接続および認証する2つの方法があります。Basic およびOAuth です。

Basic 認証

1. API トークンを取得します。
   1. Pipedrive ポータルを開きます。
   2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
   3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
   4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
2. 次の接続プロパティを設定します。
   • APIToken：取得したAPI トークンの値。
   • CompanyDomain：開発者サンドボックスURL のCompanyDomain。
   • AuthScheme：Basic。
3. 承認されたユーザー名とパスワードでログインします。

API トークンはPipedrive ポータルに保存されます。これを取得するには、会社名をクリックし、ドロップダウンリストを使用して会社設定 -> Personal Preferences -> API に移動します。

OAuth 認証

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

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

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

java -jar cdata.jdbc.pipedrive.jar

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

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

jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\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

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

embulk run pipedrive-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.pipedrive.jar
	driver_class: cdata.jdbc.pipedrive.PipedriveDriver
	url: jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;
	query: "SELECT PersonName, UserEmail FROM Deals WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Deals"
	mode: insert

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

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