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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSage Cloud Accounting データをモデル化

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

engine = create_engine("sagebcaccounting///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

埋め込みOAuth 接続を使用することでSage Business Cloud Accounting に接続できます。接続すると、ブラウザにSage Business Cloud Accounting OAuth エンドポイントが開きます。 OAuth 処理を完了するにはログインして権限を付与します。OAuth 認証フローの詳細については、オンラインヘルプドキュメントの「OAuth」セクションを参照してください。

Sage Cloud Accounting データのマッピングクラスの宣言

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

base = declarative_base()
class SalesInvoices(base):
	__tablename__ = "SalesInvoices"
	contact_name = Column(String,primary_key=True)
	total_amount = Column(String)
	...

Sage Cloud Accounting データをクエリ

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

query メソッドを使う

engine = create_engine("sagebcaccounting///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(SalesInvoices).filter_by(sent="TRUE"):
	print("contact_name: ", instance.contact_name)
	print("total_amount: ", instance.total_amount)
	print("---------")

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

execute メソッドを使う

SalesInvoices_table = SalesInvoices.metadata.tables["SalesInvoices"]
for instance in session.execute(SalesInvoices_table.select().where(SalesInvoices_table.c.sent == "TRUE")):
	print("contact_name: ", instance.contact_name)
	print("total_amount: ", instance.total_amount)
	print("---------")

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

Sage Cloud Accounting データの挿入（INSERT）

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

new_rec = SalesInvoices(contact_name="placeholder", sent="TRUE")
session.add(new_rec)
session.commit()

Sage Cloud Accounting データを更新（UPDATE）

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

updated_rec = session.query(SalesInvoices).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.sent = "TRUE"
session.commit()

Sage Cloud Accounting データを削除（DELETE）

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

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

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

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

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