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

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

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

Magento Data への接続

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

Magento はOAuth 1 認証標準を使用します。Magento REST API に接続するには、Magento システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

また、Magento システムへのURL を提供する必要があります。URL は、Magento REST API を顧客として使用しているか管理者として使用しているかによって異なります。

• Customer: Magento を顧客として使用するには、事前にMagento のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをMagento システムのエンドポイントに設定します。

• Administrator: Magento を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。

  このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

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

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

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

pip install sqlalchemy

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

import sqlalchemy

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

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

engine = create_engine("magento///?OAuthClientId=MyConsumerKey&OAuthClientSecret=MyConsumerSecret&CallbackURL=http://127.0.0.1:33333&Url=https://mymagentohost.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

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

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

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

Magento Data をクエリ

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

query メソッドを使う

engine = create_engine("magento///?OAuthClientId=MyConsumerKey&OAuthClientSecret=MyConsumerSecret&CallbackURL=http://127.0.0.1:33333&Url=https://mymagentohost.com&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Products).filter_by(Style="High Tech"):
	print("Name: ", instance.Name)
	print("Price: ", instance.Price)
	print("---------")

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

execute メソッドを使う

Products_table = Products.metadata.tables["Products"]
for instance in session.execute(Products_table.select().where(Products_table.c.Style == "High Tech")):
	print("Name: ", instance.Name)
	print("Price: ", instance.Price)
	print("---------")

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

Magento Data の挿入（INSERT）

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

new_rec = Products(Name="placeholder", Style="High Tech")
session.add(new_rec)
session.commit()

Magento Data を更新（UPDATE）

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

updated_rec = session.query(Products).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Style = "High Tech"
session.commit()

Magento Data を削除（DELETE）

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

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

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

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