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

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

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

Exact Online Data への接続

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

Exact Online はOAuth 認証標準を使用します。埋め込みクレデンシャルを使用する、またはExact にOAuth アプリを登録して独自のクレデンシャルを取得できます。 OAuth 値に加え、Region を指定します。Division が設定されない場合は、デフォルトのDivision が使用されます。

詳しくは、ヘルプドキュメントの「はじめに」を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でExact Online Data をモデル化します

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

engine = create_engine("exactonline///?Region='United States'&Division=5512&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

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

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

Exact Online Data をクエリ

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

query メソッドを使う

engine = create_engine("exactonline///?Region='United States'&Division=5512&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(IsCompetitor="False"):
	print("Name: ", instance.Name)
	print("CreditLinePurchase: ", instance.CreditLinePurchase)
	print("---------")

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

execute メソッドを使う

Accounts_table = Accounts.metadata.tables["Accounts"]
for instance in session.execute(Accounts_table.select().where(Accounts_table.c.IsCompetitor == "False")):
	print("Name: ", instance.Name)
	print("CreditLinePurchase: ", instance.CreditLinePurchase)
	print("---------")

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

Exact Online Data の挿入（INSERT）

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

new_rec = Accounts(Name="placeholder", IsCompetitor="False")
session.add(new_rec)
session.commit()

Exact Online Data を更新（UPDATE）

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

updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.IsCompetitor = "False"
session.commit()

Exact Online Data を削除（DELETE）

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

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

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

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