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

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData JDBC Driver とオープンソースのETL/ELT ツールであるEmbulk を使ってAgileCRM のデータをデータベースにロードする方法を解説します。



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

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

AgileCRM への JDBC 接続を設定

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

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

まず、Profile 接続プロパティをディスク上の AgileCRM プロファイルの場所に設定します（例：C:\profiles\Agilecrm.apip）。次に、ProfileSettings 接続プロパティを AgileCRM の接続文字列に設定します（以下を参照）。

AgileCRM API プロファイル設定

AgileCRM にログインし、「Admin Settings > Developers & API > REST API」に移動すると、API キーを確認できます。ドメインは、AgileCRM アカウントの URL に含まれるサブドメインです。

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

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


java -jar cdata.jdbc.api.jar

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

組み込みの接続文字列デザイナーを使用してJDBC URL を生成（Salesforce の例）

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


jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';

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

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

  1. Embulk にJDBC 入力プラグインをインストールします。
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
    2. 
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 を使用してAgileCRM のデータをMySQL にロードする準備が整いました。

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

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

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

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


in:
	type: jdbc
	driver_path: C:\Program Files\CData\CData API Driver for JDBC 20xx\lib\cdata.jdbc.api.jar
	driver_class: cdata.jdbc.api.APIDriver
	url: jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';
	table: "Campaigns"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Campaigns"
	mode: insert

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


embulk run api-mysql.yml

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

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

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


in:
	type: jdbc
	driver_path: C:\Program Files\CData\CData API Driver for JDBC 20xx\lib\cdata.jdbc.api.jar
	driver_class: cdata.jdbc.api.APIDriver
	url: jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';
	query: "SELECT Id, Name FROM Campaigns WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Campaigns"
	mode: insert

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

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

はじめる準備はできましたか？

API Driver で AgileCRM のライブデータに接続

AgileCRM に接続

この記事の内容

関連記事