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

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

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

Ponparemall への接続

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

Ponparemall に接続するには、ShopUrl、InventoryUserId、InventoryPassword、OrderUserId、OrderPassword、PaymentUserId、およびPaymentPassword が必要です。

Ponparemall へのアクセスの設定

Ponparemall には各API のId とPassword が必要です。取得するには、以下の手順に従ってください。

• Ponparemall Manager にログインし、メニューの「各種申請」の「WebAPI利用申請」をクリックします。
• Web API メニューの「WebAPIサービス利用申請」をクリックし、利用申請を行います。
• 後日、Ponparemall から必要なId とPassword が送られてきます。

Ponparemall アカウントの認証

次の接続プロパティを設定して接続します。

• ShopUrl：接続先のPonparemall Shop URL を設定。「http://storetst4.ponparemall.com/sample/」に含まれる「sample」の部分を入力します。
• InventoryUserId：「在庫API」のユーザID を設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
• InventoryPassword：「在庫API」のパスワードを設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
• OrderUserId：「受注API」のユーザID を設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
• OrderPassword：「受注API」のパスワードを設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
• PaymentUserId：「決済API」のユーザID を設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。
• PaymentPassword：「決済API」のパスワードを設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でPonparemall データをモデル化

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

engine = create_engine("ponparemall///?InventoryUserId=Inventory UserId&InventoryPassword=Invetory Password")

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

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

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

Ponparemall データをクエリ

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

query メソッドを使う

engine = create_engine("ponparemall///?InventoryUserId=Inventory UserId&InventoryPassword=Invetory Password")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(DateRangeSearchColumn="2"):
	print("OrderNumber: ", instance.OrderNumber)
	print("OrderStatus: ", instance.OrderStatus)
	print("---------")

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

execute メソッドを使う

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.DateRangeSearchColumn == "2")):
	print("OrderNumber: ", instance.OrderNumber)
	print("OrderStatus: ", instance.OrderStatus)
	print("---------")

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

Ponparemall データの挿入（INSERT）

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

new_rec = Orders(OrderNumber="placeholder", DateRangeSearchColumn="2")
session.add(new_rec)
session.commit()

Ponparemall データを更新（UPDATE）

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

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.DateRangeSearchColumn = "2"
session.commit()

Ponparemall データを削除（DELETE）

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

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

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

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