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

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

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

Shopify のデータ への接続

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

それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

アクセストークンによる接続

アクセストークン経由の接続には、以下の2つのステップが必要です。

1. Shopify の管理画面でアクセストークンを作成
2. アクセストークンを使用して認証

アクセストークンの作成

まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

1. 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
2. Develop apps をクリックしてCreate an app を選択します
3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
4. Save をクリックします
5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
   • unauthenticated_read_content
6. Save をクリックします
7. API Credentials を選択します
8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
9. Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

アクセストークンによる認証

続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

• AuthScheme：AccessToken に設定
• AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

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

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

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 での Shopify のデータ のモデリング

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

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

engine = create_engine("shopify:///?AppId=MyAppId&Password=MyPassword&ShopUrl=https://yourshopname.myshopify.com")

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

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

base = declarative_base()
class Customers(base):
	__tablename__ = "Customers"
	FirstName = Column(String,primary_key=True)
	Id = Column(String)
	...

Shopify のデータ のクエリ

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

query メソッドの使用

engine = create_engine("shopify:///?AppId=MyAppId&Password=MyPassword&ShopUrl=https://yourshopname.myshopify.com")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers).filter_by(FirstName="jdoe1234"):
	print("FirstName: ", instance.FirstName)
	print("Id: ", instance.Id)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

Customers_table = Customers.metadata.tables["Customers"]
for instance in session.execute(Customers_table.select().where(Customers_table.c.FirstName == "jdoe1234")):
	print("FirstName: ", instance.FirstName)
	print("Id: ", instance.Id)
	print("---------")

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

Shopify のデータ の挿入

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

new_rec = Customers(FirstName="placeholder", FirstName="jdoe1234")
session.add(new_rec)
session.commit()

Shopify のデータ の更新

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

updated_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.FirstName = "jdoe1234"
session.commit()

Shopify のデータ の削除

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

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

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

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