SQLAlchemy ORM を使って、Python でSage 50 UK のデータに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSage 50 UK のデータをモデル化

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

engine = create_engine("sage50uk///?URL=http://your-server:5493/sdata/accounts50/GCRM/your-address&User=Manager")

Note：Sage 50 UK 2012 以降のみサポートされています。

「接続」セクションのUser およびPassword プロパティを、有効なSage 50 UK のユーザー資格情報に設定する必要があります。これらの値は、Sage 50 UK に ログインするために使用するものと同じです。

さらに、「接続」セクションのURL プロパティを、希望する会社データセットのアドレスに設定する必要がります。アドレスを取得するには、以下を行ってください：

1. Sage 50 UK ソフトウェアを開きます。
2. 「Tools」->「Internet Options」をクリックします。
3. 「SData Settings」タブを選択します。
4. 「Sage 50 Accounts」の隣にある「Details」ボタンをクリックします。会社名のリストとそれに対応するデータセットのアドレスを含むウィンドウが表示されます。
5. URL プロパティを希望する会社の隣にあるアドレスフィールドの値に設定します。

Sage 50 UK のデータのマッピングクラスの宣言

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

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

Sage 50 UK のデータをクエリ

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

query メソッドを使う

engine = create_engine("sage50uk///?URL=http://your-server:5493/sdata/accounts50/GCRM/your-address&User=Manager")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(TradingAccounts).filter_by(TradingAccountUUID="c2ef66a5-a545-413b-9312-79a53caadbc4"):
	print("Name: ", instance.Name)
	print("FinanceBalance: ", instance.FinanceBalance)
	print("---------")

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

execute メソッドを使う

TradingAccounts_table = TradingAccounts.metadata.tables["TradingAccounts"]
for instance in session.execute(TradingAccounts_table.select().where(TradingAccounts_table.c.TradingAccountUUID == "c2ef66a5-a545-413b-9312-79a53caadbc4")):
	print("Name: ", instance.Name)
	print("FinanceBalance: ", instance.FinanceBalance)
	print("---------")

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

Sage 50 UK のデータの挿入（INSERT）

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

new_rec = TradingAccounts(Name="placeholder", TradingAccountUUID="c2ef66a5-a545-413b-9312-79a53caadbc4")
session.add(new_rec)
session.commit()

Sage 50 UK のデータを更新（UPDATE）

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

updated_rec = session.query(TradingAccounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.TradingAccountUUID = "c2ef66a5-a545-413b-9312-79a53caadbc4"
session.commit()

Sage 50 UK のデータを削除（DELETE）

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

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

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

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

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