Shopify のデータをPythonのpetlでETL処理する方法｜CData Connect AI

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData Connect AI Python SDKとpetlフレームワークで、リアルタイムのShopify のデータを抽出・変換・ロードするETLパイプラインの構築方法を解説。読み取りから書き込みまで対応します。

CData Connect AI の Python SDK と petl フレームワークを使うと、Shopify のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、Shopify のデータを抽出・変換して CSV などに出力する Shopify 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってShopify のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

Shopify データの定期抽出パイプライン構築

SQL クエリで取得した Shopify のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで Shopify 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

Shopify への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを Shopify に自動で書き戻す処理を組み込めます。

Connect AI で Shopify に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします
    2. 接続の追加
  2. 「Add Connection」パネルから「Shopify」を選択します
    3. データソースの選択
  3. Shopify に接続するために必要な認証プロパティを入力します。

    それでは、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 認証の使用」をご確認ください。

    接続の設定（Salesforce の例）
  4. 「Save & Test」をクリックします
  5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。 権限の更新

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

  1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
  2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
  3. PAT に名前を付けて Create をクリックします。 新しい PAT の作成
  4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で Shopify のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Shopify をクエリする SQL ステートメントを作成する方法は？

SQL を使って、Shopify をクエリするステートメントを作成します。この記事では、Customers エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Shopify1）になります。

sql = (
    "SELECT FirstName, Id "
    "FROM [Shopify1].[Shopify].[Customers] "
    "WHERE FirstName = 'jdoe1234'"
)

Shopify のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってShopify のデータを抽出・変換・ロードします。この例では、Shopify のデータを抽出し、Id カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Id')

etl.tocsv(table2, 'customers_data.csv')

新しい行を Shopify に書き戻す方法は？

Shopify が書き込みに対応している場合は、バッチ INSERT で行を書き戻せます。SDK の executemany は、@name のプレースホルダーと、1行につき1つのパラメータ辞書のリストを受け取ります。

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Shopify1].[Shopify].[Customers] (FirstName, Id) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにShopify のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのShopify のデータをパイプライン処理できるようになりました。Shopify（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ


完全なソースコード

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT FirstName, Id "
    "FROM [Shopify1].[Shopify].[Customers] "
    "WHERE FirstName = 'jdoe1234'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'Id')

etl.tocsv(table2, 'customers_data.csv')

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Shopify1].[Shopify].[Customers] (FirstName, Id) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事