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

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムMoney Forward Expense data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Money Forward Expense に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Money Forward Expense 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います（特にJOIN やSQL 関数など）。

Money Forward Expense Data への接続

Money Forward Expense data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

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

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

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからMoney Forward Expense に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でMoney Forward Expense Data をモデル化します

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

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

Money Forward Expense Data のマッピングクラスの宣言

接続を確立したら、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 Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 Data の挿入（INSERT）

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

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

Money Forward Expense Data を更新（UPDATE）

Money Forward Expense data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションで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 Data を削除（DELETE）

Money Forward Expense data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 Connector の30日の無償トライアル をぜひダウンロードして、Money Forward Expense data への接続をPython アプリやスクリプトから簡単に作成しましょう。