SQLAlchemy ORM を使って、Python でReckon Accounts Hosted データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でReckon Accounts Hosted データをモデル化

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

engine = create_engine("reckonaccountshosted///?SubscriptionKey=my_subscription_key&CountryVersion=2021.R2.AU&CompanyFile=Q:/CompanyName.QBW&User=my_user&Password=my_password&CallbackURL=http://localhost:33333&OAuthClientId=my_oauth_client_id&OAuthClientSecret=my_oauth_client_secret&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

CData 製品 はOAuth 経由でReckon Accounts Hosted にリクエストを作成します。次の接続プロパティを指定します。

• User： 必須。企業ファイルのユーザー名。
• Password： 必須。企業ファイルのパスワード。
• CompanyFile: 必須。企業ファイルへのパス。
• InitiateOAuth：アクセストークンの処理をドライバーに任せる場合はGETANDREFRESH に設定。
• CountryVersion：デフォルトは、2021.R2.AU です。

カスタムOAuth アプリケーションを作成し、以下の追加の接続プロパティを指定することもできます。

• SubscriptionKey：Azure Platform 上のReckon Portal から取得したAPI キー。
• OAuthClientId：アプリケーション設定のクライアントID に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• CallbackURL：カスタムOAuth アプリのリダイレクトURI。

CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。ほかのOAuth 認証方法（Web、ヘッドレスなど）、カスタムOAuth アプリケーションの作成、その理由などについては、ヘルプドキュメントを参照してください。

Reckon Accounts Hosted データのマッピングクラスの宣言

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

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

Reckon Accounts Hosted データをクエリ

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

query メソッドを使う

engine = create_engine("reckonaccountshosted///?SubscriptionKey=my_subscription_key&CountryVersion=2021.R2.AU&CompanyFile=Q:/CompanyName.QBW&User=my_user&Password=my_password&CallbackURL=http://localhost:33333&OAuthClientId=my_oauth_client_id&OAuthClientSecret=my_oauth_client_secret&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(IsActive="true"):
	print("Name: ", instance.Name)
	print("Balance: ", instance.Balance)
	print("---------")

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

execute メソッドを使う

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

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

Reckon Accounts Hosted データの挿入（INSERT）

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

new_rec = Accounts(Name="placeholder", IsActive="true")
session.add(new_rec)
session.commit()

Reckon Accounts Hosted データを更新（UPDATE）

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

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.IsActive = "true"
session.commit()

Reckon Accounts Hosted データを削除（DELETE）

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

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

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

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

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