SQLAlchemy ORM を使って、Python でAvalara AvaTax データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でAvalara AvaTax データをモデル化

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

engine = create_engine("avalaraavatax///?User=MyUser&Password=MyPassword")

Basic 認証を実行する通常の方法は、次のログイン資格情報を提供することです。

• User：ユーザー名に設定します。
• Password：パスワードに設定します。

サンドボックス環境を使用している場合には、オプションで次を設定してください。

• UseSandbox：サンドボックスアカウントで認証する場合にはこれをtrue に設定します。

アカウント番号とライセンスキーを使用して認証する

または、アカウント番号とライセンスキーを使用して認証することもできます。次を使用してデータに接続します。

• AccountId：これをアカウントId に設定します。アカウントId は管理コンソールの右上端にリストされています。
• LicenseKey：これをAvalara Avatax のライセンスキーに設定します。ライセンスキーの生成は、Avalara Avatax アカウント管理者としてログインして Settings -> Reset License Key に移動して実行できます。

Avalara AvaTax データのマッピングクラスの宣言

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

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

Avalara AvaTax データをクエリ

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

query メソッドを使う

engine = create_engine("avalaraavatax///?User=MyUser&Password=MyPassword")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Transactions).filter_by(Code="051349"):
	print("Id: ", instance.Id)
	print("TotalTax: ", instance.TotalTax)
	print("---------")

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

execute メソッドを使う

Transactions_table = Transactions.metadata.tables["Transactions"]
for instance in session.execute(Transactions_table.select().where(Transactions_table.c.Code == "051349")):
	print("Id: ", instance.Id)
	print("TotalTax: ", instance.TotalTax)
	print("---------")

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

Avalara AvaTax データの挿入（INSERT）

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

new_rec = Transactions(Id="placeholder", Code="051349")
session.add(new_rec)
session.commit()

Avalara AvaTax データを更新（UPDATE）

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

updated_rec = session.query(Transactions).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Code = "051349"
session.commit()

Avalara AvaTax データを削除（DELETE）

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

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

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

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

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