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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSuiteCRM データをモデル化

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

engine = create_engine("suitecrm///?URL=http://mySuiteCRM.com&User=myUser&Password=myPassword")

次の接続プロパティを設定すると、V4.1 API 経由でSuiteCRM データに接続できます。

• Schema：suitecrmv4 に設定。
• Url：SuiteCRM アプリケーションに紐づいているURL（例：http://suite.crm.com）に設定。
• User：SuiteCRM に紐づいているユーザーに設定。
• Password：SuiteCRM に紐づいているパスワードに設定。

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

SuiteCRM データのマッピングクラスの宣言

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

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

SuiteCRM データをクエリ

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

query メソッドを使う

engine = create_engine("suitecrm///?URL=http://mySuiteCRM.com&User=myUser&Password=myPassword")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(Industry="Manufacturing"):
	print("Name: ", instance.Name)
	print("Industry: ", instance.Industry)
	print("---------")

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

execute メソッドを使う

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

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

SuiteCRM データの挿入（INSERT）

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

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

SuiteCRM データを更新（UPDATE）

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

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Industry = "Manufacturing"
session.commit()

SuiteCRM データを削除（DELETE）

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

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

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

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

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