SQLAlchemy ORM を使って、Python でSugar CRM データに連携する方法

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

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for SugarCRM は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Sugar CRM にデータ連携するPython アプリケーションを構築し、Sugar CRM データを可視化できます。 本記事では、SQLAlchemy でSugar CRM に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Sugar CRM をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにSugar CRM データを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてSugar CRM の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でSugar CRM データをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Sugar CRM データに連携するEngne を作成します。

engine = create_engine("sugarcrm///?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 データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Accounts テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Accounts(base):
	__tablename__ = "Accounts"
	Name = Column(String,primary_key=True)
	AnnualRevenue = Column(String)
	...

Sugar CRM データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("sugarcrm///?User=MyUser&Password=MyPassword&URL=MySugarCRMAccountURL&CacheMetadata=True")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(Name="Bob"):
	print("Name: ", instance.Name)
	print("AnnualRevenue: ", instance.AnnualRevenue)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Accounts_table = Accounts.metadata.tables["Accounts"]
for instance in session.execute(Accounts_table.select().where(Accounts_table.c.Name == "Bob")):
	print("Name: ", instance.Name)
	print("AnnualRevenue: ", instance.AnnualRevenue)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Sugar CRM データの挿入（INSERT）

Sugar CRM データへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Sugar CRM にすべての追加インスタンスを送ります。

new_rec = Accounts(Name="placeholder", Name="Bob")
session.add(new_rec)
session.commit()

Sugar CRM データを更新（UPDATE）

Sugar CRM データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Sugar CRM にレコードを追加します。

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "Bob"
session.commit()

Sugar CRM データを削除（DELETE）

Sugar CRM データの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

deleted_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Sugar CRM からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。