Embulk を使用して Shopify ののデータをデータベースにロードする方法

Embulk はオープンソースのバルクデータローダーです。CData JDBC Driver for Shopify と組み合わせることで、Shopify から任意の同期先にデータを簡単にロードできます。この記事では、CData JDBC Driver for Shopify をEmbulk で使用してShopify のデータをMySQL データベースにロードする方法を解説します。

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

Shopify への JDBC 接続を設定

Embulk でバルクロードジョブを作成する前に、JDBC Driver のJAR ファイルのインストール場所（通常はC:\Program Files\CData\CData JDBC Driver for Shopify\lib）を確認しておきます。

Embulk はJDBC 接続をサポートしているため、Shopify に簡単に接続してSQL クエリを実行できます。バルクロードジョブを作成する前に、Shopify への認証用のJDBC URL を作成します。

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

組み込みの接続文字列デザイナー

JDBC URL の作成には、Shopify JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.shopify.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

以下は、Shopify への一般的なJDBC 接続文字列です。

jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;

Embulk で Shopify ののデータをロード

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

1. Embulk にJDBC 入力プラグインをインストールします。
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. この記事では、同期先データベースとしてMySQL を使用します。出力プラグインを使用して、SQL Server、PostgreSQL、またはGoogle BigQuery を同期先として選択することもできます。
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

入力プラグインと出力プラグインをインストールしたら、Embulk を使用してShopify のデータをMySQL にロードする準備が整いました。

Shopify ののデータをロードするジョブを作成

まず、Embulk で設定ファイルを作成します。ファイル名はshopify-mysql.yml のようにします。

1. 入力プラグインのオプションには、CData JDBC Driver for Shopify、ドライバーJAR ファイルへのパス、ドライバークラス（例：cdata.jdbc.shopify.ShopifyDriver）、および上記のJDBC URL を指定します。
2. 出力プラグインのオプションには、MySQL データベースの値と認証情報を指定します。

設定ファイルのサンプル（shopify-mysql.yml）

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.shopify.jar
	driver_class: cdata.jdbc.shopify.ShopifyDriver
	url: jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
	table: "Customers"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

ファイルを作成したら、Embulk ジョブを実行します。

embulk run shopify-mysql.yml

Embulk ジョブを実行すると、MySQL テーブルにShopify のデータが格納されます。

フィルタリングした Shopify ののデータをロード

テーブルから直接データをロードするだけでなく、カスタムSQL クエリを使用してロードするデータをより詳細に制御できます。また、クエリフィールドのSQL WHERE 句で最終更新カラムを設定することで、増分ロードを実行することもできます。

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.shopify.jar
	driver_class: cdata.jdbc.shopify.ShopifyDriver
	url: jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
	query: "SELECT FirstName, Id FROM Customers WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

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

CData JDBC Driver for Shopify をコネクタとして使用することで、Embulk のデータロードジョブにShopify のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。