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

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

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

Acumatica Data への接続

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

Acumatica に接続するには、次の接続プロパティを設定してください。

• User：ユーザー名に設定。
• Password：パスワードに設定。
• Company：会社名に設定。
• Url：Acumantica URL に、http://{Acumatica ERP instance URL}/entity/{Endpoint name}/{Endpoint version}/ の形式で設定。
  例えば、https://acumatica.com/entity/Default/17.200.001/。

詳細については、CData ドライバードキュメントの「はじめに」を参照してください。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("acumatica///?Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/&User=user&Password=password&Company=CompanyName")

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

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

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

Acumatica Data をクエリ

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

query メソッドを使う

engine = create_engine("acumatica///?Url = https://try.acumatica.com/ISV/entity/Default/17.200.001/&User=user&Password=password&Company=CompanyName")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Events).filter_by(Id="1"):
	print("Id: ", instance.Id)
	print("location_displayname: ", instance.location_displayname)
	print("---------")

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

execute メソッドを使う

Events_table = Events.metadata.tables["Events"]
for instance in session.execute(Events_table.select().where(Events_table.c.Id == "1")):
	print("Id: ", instance.Id)
	print("location_displayname: ", instance.location_displayname)
	print("---------")

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

Acumatica Data の挿入（INSERT）

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

new_rec = Events(Id="placeholder", Id="1")
session.add(new_rec)
session.commit()

Acumatica Data を更新（UPDATE）

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

updated_rec = session.query(Events).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Id = "1"
session.commit()

Acumatica Data を削除（DELETE）

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

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

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

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