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

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

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

TaxJar Data への接続

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

TaxJar API への認証には、まず初めにTaxJar UI からAPI キーを取得する必要があります。

NOTE：API の利用は、Professional およびPremium TaxJar プランでのみ可能です。

すでにProfessional またはPremium プランをお持ちの方は、TaxJar UI にログインして、「アカウント」->「TaxJar API」に移動するとAPI キーを確認することができます。 API キーを取得したら、APIKey 接続プロパティに設定できます。

その他の注意事項

• デフォルトでは、エンティティが日付範囲フィルタをサポートしている場合、CData コネクタは過去3か月のデータを取得します。StartDate を設定して、取得するデータの最小作成日を指定することができます。
• API キーがサンドボックスAPI アカウント用に作成されている場合は、UseSandbox をtrue に設定してください。ただし、すべてのエンドポイントが期待どおりに機能するとは限りません。詳しくは、TaxJar 開発者用ドキュメントを参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("taxjar///?APIKey=3bb04218ef8t80efdf1739abf7257144")

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

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

base = declarative_base()
class Orders(base):
	__tablename__ = "Orders"
	TransactionID = Column(String,primary_key=True)
	UserID = Column(String)
	...

TaxJar Data をクエリ

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

query メソッドを使う

engine = create_engine("taxjar///?APIKey=3bb04218ef8t80efdf1739abf7257144")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(TransactionID="123"):
	print("TransactionID: ", instance.TransactionID)
	print("UserID: ", instance.UserID)
	print("---------")

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

execute メソッドを使う

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.TransactionID == "123")):
	print("TransactionID: ", instance.TransactionID)
	print("UserID: ", instance.UserID)
	print("---------")

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

TaxJar Data の挿入（INSERT）

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

new_rec = Orders(TransactionID="placeholder", TransactionID="123")
session.add(new_rec)
session.commit()

TaxJar Data を更新（UPDATE）

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

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.TransactionID = "123"
session.commit()

TaxJar Data を削除（DELETE）

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

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

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

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