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

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

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

Xero WorkflowMax への接続

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

WorkflowMax API に接続するには、Xero からAPIKey とAccountKey を取得します。取得については、 Xero のサポートにお問い合わせ頂く必要があります。(https://www.workflowmax.com/contact-us).

API キーとAccount キーを取得したら、APIKey とAccountKey 接続プロパティの値を設定してください。 これらが設定されれば、接続の準備は完了です。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でXero WorkflowMax データをモデル化

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

engine = create_engine("xeroworkflowmax///?APIKey=myApiKey&AccountKey=myAccountKey")

Xero WorkflowMax データのマッピングクラスの宣言

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

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

Xero WorkflowMax データをクエリ

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

query メソッドを使う

engine = create_engine("xeroworkflowmax///?APIKey=myApiKey&AccountKey=myAccountKey")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Clients).filter_by(Name="Cynthia"):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

execute メソッドを使う

Clients_table = Clients.metadata.tables["Clients"]
for instance in session.execute(Clients_table.select().where(Clients_table.c.Name == "Cynthia")):
	print("Id: ", instance.Id)
	print("Name: ", instance.Name)
	print("---------")

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

Xero WorkflowMax データの挿入（INSERT）

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

new_rec = Clients(Id="placeholder", Name="Cynthia")
session.add(new_rec)
session.commit()

Xero WorkflowMax データを更新（UPDATE）

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

updated_rec = session.query(Clients).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "Cynthia"
session.commit()

Xero WorkflowMax データを削除（DELETE）

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

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

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

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