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

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

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

GMO MakeShop への JDBC 接続を設定

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

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

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 を実行する場合に必要です。

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

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

java -jar cdata.jdbc.gmomakeshop.jar

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

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

jdbc:gmomakeshop:ShopId=MyShopId;ProductsAccessCode=MyProductsAccessCode;MembersAccessCode=MyMembersAccessCode;OrdersAccessCode=MyOrdersAccessCode;

Embulk で GMO MakeShop ののデータをロード

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 を使用してGMO MakeShop のデータをMySQL にロードする準備が整いました。

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.gmomakeshop.jar
	driver_class: cdata.jdbc.gmomakeshop.GMOMakeShopDriver
	url: jdbc:gmomakeshop:ShopId=MyShopId;ProductsAccessCode=MyProductsAccessCode;MembersAccessCode=MyMembersAccessCode;OrdersAccessCode=MyOrdersAccessCode;
	table: "Products"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Products"
	mode: insert

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

embulk run gmomakeshop-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.gmomakeshop.jar
	driver_class: cdata.jdbc.gmomakeshop.GMOMakeShopDriver
	url: jdbc:gmomakeshop:ShopId=MyShopId;ProductsAccessCode=MyProductsAccessCode;MembersAccessCode=MyMembersAccessCode;OrdersAccessCode=MyOrdersAccessCode;
	query: "SELECT BrandCode, Price FROM Products WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Products"
	mode: insert

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

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