SQLAlchemy ORM を使って、Python でe-Sales Manager データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でe-Sales Manager データをモデル化

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

engine = create_engine("esalesmanager///?User=MyUsername&Password=MyPassword&URL=MyInstanceURL&TenantId=MyTenantId")

e セールスマネージャー Remix に接続するには、User、Passowrd、URL、TenantId パラメータが必要です。

• User：API を実行するためのログインユーザーのユーザーID。
• Password：API を実行するためのログインユーザーのユーザーパスワード
。
• URL：e-Sales Manager Remix エンドポイントへのURL。例：https://XXX.softbrain.co.jp
• TenantId：e-Sales Manager Remix テナント名のTenantd。例：cdata

e-Sales Manager データのマッピングクラスの宣言

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

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

e-Sales Manager データをクエリ

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

query メソッドを使う

engine = create_engine("esalesmanager///?User=MyUsername&Password=MyPassword&URL=MyInstanceURL&TenantId=MyTenantId")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customer).filter_by(Address="CustomerAddress"):
	print("Name: ", instance.Name)
	print("Address: ", instance.Address)
	print("---------")

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

execute メソッドを使う

Customer_table = Customer.metadata.tables["Customer"]
for instance in session.execute(Customer_table.select().where(Customer_table.c.Address == "CustomerAddress")):
	print("Name: ", instance.Name)
	print("Address: ", instance.Address)
	print("---------")

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

e-Sales Manager データの挿入（INSERT）

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

new_rec = Customer(Name="placeholder", Address="CustomerAddress")
session.add(new_rec)
session.commit()

e-Sales Manager データを更新（UPDATE）

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

updated_rec = session.query(Customer).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Address = "CustomerAddress"
session.commit()

e-Sales Manager データを削除（DELETE）

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

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

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

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

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