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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でMYOB AccountRight のデータをモデル化

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

engine = create_engine("myob///?OAuthClientId=YourClientId& OAuthClientSecret=YourClientSecret& CompanyFileId=yourCompanyFileId& CallbackURL=http://localhost:33333& User=companyFileUser& Password=companyFilePassword& InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

MYOB への接続

MYOB 会社ファイルに接続するには、CompanyFileId をデータを取得したい会社ファイルのID に設定します。指定しない場合は、最初に返された会社ファイルのID（アルファベット順にソート）が使用されます。

この接続プロパティは、CompanyFiles ビューを除くすべてのテーブルおよびビューにアクセスするために必要です。CompanyFiles ビューは、アカウントに紐づく会社ファイル（およびその関連ID）を表示するために使用できます。会社ファイルのID がわからない場合は、このビューを使用してください。

次のプロパティを追加設定します。

OAuth で認証する場合は、さらにヘルプドキュメントを参照してください。

MYOB AccountRight のデータのマッピングクラスの宣言

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

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

MYOB AccountRight のデータをクエリ

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

query メソッドを使う

engine = create_engine("myob///?OAuthClientId=YourClientId& OAuthClientSecret=YourClientSecret& CompanyFileId=yourCompanyFileId& CallbackURL=http://localhost:33333& User=companyFileUser& Password=companyFilePassword& InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(Type="Bank"):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

execute メソッドを使う

Accounts_table = Accounts.metadata.tables["Accounts"]
for instance in session.execute(Accounts_table.select().where(Accounts_table.c.Type == "Bank")):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

MYOB AccountRight のデータの挿入（INSERT）

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

new_rec = Accounts(Id="placeholder", Type="Bank")
session.add(new_rec)
session.commit()

MYOB AccountRight のデータを更新（UPDATE）

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

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Type = "Bank"
session.commit()

MYOB AccountRight のデータを削除（DELETE）

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

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

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

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

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