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

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Avalara Python Connector

AvaTax へのデータ連携用のPython Connecotr ライブラリ。 pandas、SQLAlchemy、Dash、petl などの主要なPython ツールにAvaTax をシームレスに統合。



CData Python Connector for Avalara AvaTax を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でAvalara AvaTax にOR マッピング可能に。

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

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

Avalara AvaTax Data への接続

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

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

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

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

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

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

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でAvalara AvaTax Data をモデル化します

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

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

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

接続を確立したら、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 Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 Data の挿入(INSERT)

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

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

Avalara AvaTax Data を更新(UPDATE)

Avalara AvaTax data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションで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 Data を削除(DELETE)

Avalara AvaTax data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 Connector の30日の無償トライアル をぜひダウンロードして、Avalara AvaTax data への接続をPython アプリやスクリプトから簡単に作成しましょう。