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

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

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

Sugar CRM への JDBC 接続を設定

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

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

CData 製品をSugarCRM に認証するには、以下を有効なSugarCRM ユーザー資格情報に設定する必要があります。User：SugarCRM アカウントのユーザー。Password：SugarCRM アカウントのパスワード。

OAuth consumer key とconsumer secret は、Admin -> OAuth Keys で生成することができます。OAuthClientId にOAuth consumer key を、OAuthClientSecret にconsumer secret　を設定します。

さらに、SugarCRM への接続を確立するには以下を指定します。URL：'http://{sugar crm instance}.com' の形式で、SugarCRM アカウントに紐付いているURL に設定。Platform：認証中にログインの競合が発生した場合は、SugarCRM UI で作成したプラットフォームのいずれかに設定。

SugarCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。

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

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

java -jar cdata.jdbc.sugarcrm.jar

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

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

jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;

Embulk で Sugar CRM ののデータをロード

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.sugarcrm.jar
	driver_class: cdata.jdbc.sugarcrm.SugarCRMDriver
	url: jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;
	table: "Accounts"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Accounts"
	mode: insert

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

embulk run sugarcrm-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.sugarcrm.jar
	driver_class: cdata.jdbc.sugarcrm.SugarCRMDriver
	url: jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;
	query: "SELECT Name, AnnualRevenue FROM Accounts WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Accounts"
	mode: insert

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

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