SQLAlchemy ORM を使用して Python で GMO MakeShop のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for GMO MakeShop と SQLAlchemy ツールキットを使用して、GMO MakeShop に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して GMO MakeShop のデータ に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの GMO MakeShop のデータ を操作する際に比類のないパフォーマンスを提供します。GMO MakeShop に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 GMO MakeShop にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

GMO MakeShop のデータ への接続

GMO MakeShop のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

GMO MakeShop に接続するには、MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId が必要です。

GMO MakeShop へのアクセスの設定

MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId を取得するには、以下の手順に従ってください。

• GMO MakeShop には各API のAccessCode が必要です。
• GMO MakeShop Store Manager にログインし、メニューの「ショップ作成」をクリックします。
• 左ナビゲーションメニューの「外部システム連携」から任意の連携対象設定ををクリックします（メニューに表示されない場合は別途GMO MakeShop にご確認ください）。
• 商品データ連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。
• 注文データ連携設定の場合：最初に「注文情報参照」と「注文情報変更」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、OrdersAccessCode を取得します。
• 会員データ連携設定の場合：最初に「会員情報の（参照・登録・変更・削除）」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、MembersAccessCode を取得します。
• 会員認証連携設定の場合：認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。

GMO MakeShop アカウントの認証

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

• ShopId：接続先のGMO MakeShop Store ID を設定。GMO MakeShop Store ID はログイン用の ID と同じです。
• OrdersAccessCode：「注文データ連携設定」から取得した「認証コード」を設定。このプロパティは Orders テーブルにアクセスする場合に必要です。
• ProductsAccessCode：「商品データ連携設定」から取得した「認証コード」を設定。このプロパティは Products テーブルにアクセスする場合に必要です。
• MembersAccessCode：「会員データ連携設定」から取得した「認証コード」を設定。このプロパティは Members テーブルにアクセスする場合に必要です。
• MemberAuthenticationCode：「会員認証連携設定」から取得した「認証コード」を設定。このプロパティは MemberAuthenticationConfirm を実行する場合に必要です。
• Password：GMO MakeShop Store Manager のログインユーザーのパスワードを指定。このプロパティは ProductCategoryRegistrationOrModification,ProductMemberGroupPriceRegistrationOrModification,ProductOptionRegistrationOrModification,ProductRegistrationOrModification を実行する場合に必要です。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて GMO MakeShop にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での GMO MakeShop のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、GMO MakeShop のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("gmomakeshop:///?ShopId=MyShopId&ProductsAccessCode=MyProductsAccessCode&MembersAccessCode=MyMembersAccessCode&OrdersAccessCode=MyOrdersAccessCode")

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

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

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

GMO MakeShop のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("gmomakeshop:///?ShopId=MyShopId&ProductsAccessCode=MyProductsAccessCode&MembersAccessCode=MyMembersAccessCode&OrdersAccessCode=MyOrdersAccessCode")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Products).filter_by(BrandCode="99a87c0x3"):
	print("BrandCode: ", instance.BrandCode)
	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.BrandCode == "99a87c0x3")):
	print("BrandCode: ", instance.BrandCode)
	print("Price: ", instance.Price)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

GMO MakeShop のデータ の挿入

GMO MakeShop のデータ を挿入するには、マッピングクラスのインスタンスを定義し、アクティブな session に追加します。セッションの commit 関数を呼び出して、追加されたすべてのインスタンスを GMO MakeShop にプッシュします。

new_rec = Products(BrandCode="placeholder", BrandCode="99a87c0x3")
session.add(new_rec)
session.commit()

GMO MakeShop のデータ の更新

GMO MakeShop のデータ を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを GMO MakeShop にプッシュします。

updated_rec = session.query(Products).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.BrandCode = "99a87c0x3"
session.commit()

GMO MakeShop のデータ の削除

GMO MakeShop のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

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

無料トライアルと詳細情報

CData Python Connector for GMO MakeShop の30日間の無料トライアルをダウンロードして、GMO MakeShop のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。