SQLAlchemy ORM を使って、Python でWooCommerce のデータに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. WooCommerce をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにWooCommerce のデータを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてWooCommerce の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でWooCommerce のデータをモデル化

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

engine = create_engine("woocommerce///?Url=https://example.com/& ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad& ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5& InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

WooCommerce は、one-legged OAuth1.0 認証と通常のOAuth2.0 認証をサポートします。

one-legged OAuth 1.0 認証を使って接続する

次のプロパティを指定してください（NOTE：次の資格情報はWooCommerce の設定ページで生成されるもので、WordPress OAuth2.0 プラグインで生成されるものとは異なります）。

• ConsumerKey
• ConsumerSecret

WordPress OAuth 2.0 認証を使って接続する

プラグインを設定した後、 次の接続プロパティを指定することでWooCommerce に接続できます。

• OAuthClientId
• OAuthClientSecret
• CallbackURL
• InitiateOAuth - GETANDREFRESH または REFRESH のどちらかに設定してください

どちらの場合方法でも、Url プロパティをWooCommerce インスタンスのURL に設定する必要があります。

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

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

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

WooCommerce のデータをクエリ

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

query メソッドを使う

engine = create_engine("woocommerce///?Url=https://example.com/& ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad& ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5& InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(ParentId="3"):
	print("ParentId: ", instance.ParentId)
	print("Total: ", instance.Total)
	print("---------")

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

execute メソッドを使う

Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.ParentId == "3")):
	print("ParentId: ", instance.ParentId)
	print("Total: ", instance.Total)
	print("---------")

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

WooCommerce のデータの挿入（INSERT）

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

new_rec = Orders(ParentId="placeholder", ParentId="3")
session.add(new_rec)
session.commit()

WooCommerce のデータを更新（UPDATE）

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

updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ParentId = "3"
session.commit()

WooCommerce のデータを削除（DELETE）

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

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

WooCommerce からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。