SQLAlchemy ORM を使って、Python でMoney Forward Expense データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でMoney Forward Expense データをモデル化

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

engine = create_engine("mfexpense///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&InitiateOAuth=GETANDREFRESH")

MoneyForward Expense はOAuth 2 認証標準を利用しています。MoneyForward Expense にアプリケーションを登録し、OAuthClientId およびOAuthClientSecret を取得する必要があります。認証方法については、ヘルプドキュメントの「MoneyForward Expense への接続」を参照してください。

また、ほとんどのテーブルを操作するためにOfficeId プロパティを指定する必要があります。

Money Forward Expense データのマッピングクラスの宣言

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

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

Money Forward Expense データをクエリ

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

query メソッドを使う

engine = create_engine("mfexpense///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&InitiateOAuth=GETANDREFRESH")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Offices).filter_by(Id="1668776136772254"):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

execute メソッドを使う

Offices_table = Offices.metadata.tables["Offices"]
for instance in session.execute(Offices_table.select().where(Offices_table.c.Id == "1668776136772254")):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

Money Forward Expense データの挿入（INSERT）

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

new_rec = Offices(Id="placeholder", Id="1668776136772254")
session.add(new_rec)
session.commit()

Money Forward Expense データを更新（UPDATE）

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

updated_rec = session.query(Offices).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Id = "1668776136772254"
session.commit()

Money Forward Expense データを削除（DELETE）

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

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

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

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

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