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

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

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

Qoo10 への接続

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

Qoo10 に接続するには、ApiKey、Password、およびUser が必要です。

Qoo10 へのアクセスの設定

• API Key を取得するためには、Qoo10 の営業担当者に依頼する必要があります。
• Qoo10 営業担当社へ依頼すると後日、API Key が送られてきます。

Qoo10 アカウントの認証

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

• ApiKey：Qoo10 営業担当者から受け取ったAPI Key を設定。
• User： にログインするためのユーザーID を設定。
• Password： にログインするためのパスワードを設定。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でQoo10 データをモデル化

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

engine = create_engine("qoo10///?User=userTest&Password=passwordTest&ApiKey=YOUR_API_KEY")

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

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

base = declarative_base()
class GoodsDetail(base):
	__tablename__ = "GoodsDetail"
	ItemNo = Column(String,primary_key=True)
	ItemTitle = Column(String)
	...

Qoo10 データをクエリ

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

query メソッドを使う

engine = create_engine("qoo10///?User=userTest&Password=passwordTest&ApiKey=YOUR_API_KEY")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(GoodsDetail).filter_by(ItemQty="12"):
	print("ItemNo: ", instance.ItemNo)
	print("ItemTitle: ", instance.ItemTitle)
	print("---------")

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

execute メソッドを使う

GoodsDetail_table = GoodsDetail.metadata.tables["GoodsDetail"]
for instance in session.execute(GoodsDetail_table.select().where(GoodsDetail_table.c.ItemQty == "12")):
	print("ItemNo: ", instance.ItemNo)
	print("ItemTitle: ", instance.ItemTitle)
	print("---------")

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

Qoo10 データの挿入（INSERT）

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

new_rec = GoodsDetail(ItemNo="placeholder", ItemQty="12")
session.add(new_rec)
session.commit()

Qoo10 データを更新（UPDATE）

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

updated_rec = session.query(GoodsDetail).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ItemQty = "12"
session.commit()

Qoo10 データを削除（DELETE）

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

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

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

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