SQLAlchemy ORM を使って、Python でXero データに連携

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

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

Xero Data への接続

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

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でXero Data をモデル化します

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

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

Xero Data のマッピングクラスの宣言

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

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

Xero Data をクエリ

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

query メソッドを使う

engine = create_engine("xero///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Items).filter_by(Name="Golf balls - white single"):
	print("Name: ", instance.Name)
	print("QuantityOnHand: ", instance.QuantityOnHand)
	print("---------")

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

execute メソッドを使う

Items_table = Items.metadata.tables["Items"]
for instance in session.execute(Items_table.select().where(Items_table.c.Name == "Golf balls - white single")):
	print("Name: ", instance.Name)
	print("QuantityOnHand: ", instance.QuantityOnHand)
	print("---------")

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

Xero Data の挿入（INSERT）

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

new_rec = Items(Name="placeholder", Name="Golf balls - white single")
session.add(new_rec)
session.commit()

Xero Data を更新（UPDATE）

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

updated_rec = session.query(Items).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "Golf balls - white single"
session.commit()

Xero Data を削除（DELETE）

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

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

製品の無償トライアル情報

Xero Python Connector の30日の無償トライアル をぜひダウンロードして、Xero data への接続をPython アプリやスクリプトから簡単に作成しましょう。