Python でSugar CRM データを変換・出力するETL 処理を作る方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには多くのモジュールがあり、システム構築を素早く効率的に行うことができます。本記事では、CData Python Connector for SugarCRM とpetl フレームワークを使って、Sugar CRM データにPython から接続してデータを変換、CSV に出力するETL 変換を実装してみます。

CData Python Connector は効率的なデータ処理によりSugar CRM データ にPython から接続し、高いパフォーマンスを発揮します。Sugar CRM にデータをクエリする際、ドライバーはフィルタリング、集計などがサポートされている場合SQL 処理を直接Sugar CRM 側に行わせ、サポートされていないSQL 処理については、組み込みのSQL エンジンによりクライアント側で処理を行います（JOIN やSQL 関数など）。

必要なモジュールのインストール

pip で必要なモジュールおよびフレームワークをインストールします：

pip install petl
pip install pandas

Python でSugar CRM データをETL 処理するアプリを構築

モジュールとフレームワークをインストールしたら、ETL アプリケーションを組んでいきます。コードのスニペットは以下の通りです。フルコードは記事の末尾に付いています。

CData Connector を含むモジュールをインポートします。

import petl as etl
import pandas as pd
import cdata.sugarcrm as mod

接続文字列で接続を確立します。connect 関数を使って、CData Sugar CRM Connector からSugar CRM への接続を行います

cnxn = mod.connect("User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;")

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

Sugar CRM をクエリするSQL 文の作成

Sugar CRM にはSQL でデータアクセスが可能です。Accounts エンティティからのデータを読み出します。

sql = "SELECT Name, AnnualRevenue FROM Accounts WHERE Name = 'Bob'"

Sugar CRM データ のETL 処理

DataFrame に格納されたクエリ結果を使って、petl でETL（抽出・変換・ロード）パイプラインを組みます。この例では、Sugar CRM データ を取得して、AnnualRevenue カラムでデータをソートして、CSV ファイルにデータをロードします。

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'AnnualRevenue')

etl.tocsv(table2,'accounts_data.csv')

CData Python Connector for SugarCRM を使えば、データベースを扱う場合と同感覚で、Sugar CRM データ を扱うことができ、petl のようなETL パッケージから直接データにアクセスが可能になります。

おわりに

Sugar CRM Python Connector の30日の無償トライアル をぜひダウンロードして、Sugar CRM データ への接続をPython アプリやスクリプトから簡単に作成しましょう。

フルソースコード

import petl as etl
import pandas as pd
import cdata.sugarcrm as mod

cnxn = mod.connect("User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;")

sql = "SELECT Name, AnnualRevenue FROM Accounts WHERE Name = 'Bob'"

table1 = etl.fromdb(cnxn,sql)

table2 = etl.sort(table1,'AnnualRevenue')

etl.tocsv(table2,'accounts_data.csv')