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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でDynamics GP データをモデル化

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

engine = create_engine("dynamicsgp///?CompanyId=mycompanyId&user=myuser&password=mypassword&URL= http://{servername}:{port}/Dynamics/GPService")

Dynamics GP 接続プロパティの取得・設定方法

認証するには、User およびPassword 接続プロパティを設定します。

接続するには、Url をWeb サービスのエンドポイントに設定します。例えば、http://{servername}:{port}/Dynamics/GPService です。さらに、CompanyId を設定します。この値は組織のセットアップウィンドウで「ツール」->「設定」->「組織」をクリックして取得できます。

デフォルトでデータサマリを返し、パフォーマンスを節約します。Line items などの詳細を返すには、LookupIds をtrue に設定します。ただしエンティティは一度に一つずつ返される必要があります。

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

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

base = declarative_base()
class SalesInvoice(base):
	__tablename__ = "SalesInvoice"
	CustomerName = Column(String,primary_key=True)
	TotalAmount = Column(String)
	...

Dynamics GP データをクエリ

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

query メソッドを使う

engine = create_engine("dynamicsgp///?CompanyId=mycompanyId&user=myuser&password=mypassword&URL= http://{servername}:{port}/Dynamics/GPService")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(SalesInvoice).filter_by(CustomerName="Bob"):
	print("CustomerName: ", instance.CustomerName)
	print("TotalAmount: ", instance.TotalAmount)
	print("---------")

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

execute メソッドを使う

SalesInvoice_table = SalesInvoice.metadata.tables["SalesInvoice"]
for instance in session.execute(SalesInvoice_table.select().where(SalesInvoice_table.c.CustomerName == "Bob")):
	print("CustomerName: ", instance.CustomerName)
	print("TotalAmount: ", instance.TotalAmount)
	print("---------")

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

Dynamics GP データの挿入（INSERT）

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

new_rec = SalesInvoice(CustomerName="placeholder", CustomerName="Bob")
session.add(new_rec)
session.commit()

Dynamics GP データを更新（UPDATE）

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

updated_rec = session.query(SalesInvoice).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.CustomerName = "Bob"
session.commit()

Dynamics GP データを削除（DELETE）

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

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

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

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

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