今すぐお試しください!

製品の詳細CData Python Connector for SuiteCRM を確認して、無償評価版をダウンロード:

今すぐダウンロード

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

CData Python Connector for SuiteCRM を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でSuiteCRM にOR マッピング可能に。

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムSuiteCRM data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。SuiteCRM に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接SuiteCRM 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

SuiteCRM Data への接続

SuiteCRM data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

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

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

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

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからSuiteCRM に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSuiteCRM Data をモデル化します

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

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

SuiteCRM Data のマッピングクラスの宣言

接続を確立したら、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 Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 Data の挿入(INSERT)

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

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

SuiteCRM Data を更新(UPDATE)

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

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

SuiteCRM Data を削除(DELETE)

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

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

製品の無償トライアル情報

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

 
 
ダウンロード