SQLAlchemy ORM を使用して Python で Wave Financial のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Wave Financial と SQLAlchemy ツールキットを使用して、Wave Financial に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Wave Financial のデータ に接続し、クエリを実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Wave Financial のデータ を操作する際に比類のないパフォーマンスを提供します。Wave Financial に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Wave Financial にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Wave Financial のデータ への接続

Wave Financial のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

Wave Financial 接続プロパティの取得・設定方法

Wave Financial は、データに接続する手段として、API トークンを指定する方法とOAuth 認証情報を使用する方法の2つを提供しています。

API トークン

1. Wave Financial アカウントにログインします。
2. 左ペインのManage Applications に移動します。
3. トークンを作成するアプリケーションを選択します。最初にアプリケーションを作成する必要がある場合があります。
4. API トークンを生成するには、Create token をクリックします。

OAuth

ヘルプドキュメントでは、以下の3つの一般的な認証フローでのWave Financial への認証について詳しく説明しています。

• デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。組み込みOAuth またはカスタムOAuth で認証されます。
• Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
• ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。組み込みOAuth またはカスタムOAuth で認証されます。

カスタムOAuth アプリケーションの作成についての情報と、組み込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、ヘルプドキュメント の「カスタムOAuth アプリケーションの作成」セクションを参照してください。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Wave Financial にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Wave Financial のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Wave Financial のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("wavefinancial:///?")

Wave Financial のデータ のマッピングクラスの宣言

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、Invoices テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

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

Wave Financial のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("wavefinancial:///?")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Invoices).filter_by(Status="SENT"):
	print("Id: ", instance.Id)
	print("DueDate: ", instance.DueDate)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

Invoices_table = Invoices.metadata.tables["Invoices"]
for instance in session.execute(Invoices_table.select().where(Invoices_table.c.Status == "SENT")):
	print("Id: ", instance.Id)
	print("DueDate: ", instance.DueDate)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

無料トライアルと詳細情報

CData Python Connector for Wave Financial の30日間の無料トライアルをダウンロードして、Wave Financial のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。