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

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

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

BigCommerce への JDBC 接続を設定

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

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

BigCommerce 認証は標準のOAuth フローに基づいています。

Store ID の取得

BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

1. BigCommerce アカウントにログインします。
2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
4. 画面にAPI Path という名前のテキストボックスが表示されます。
5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

パーソナルアクセストークンの取得

加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

1. BigCommerce アカウントにログインします。
2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
4. アカウント名を入力します。
5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
6. 「保存」をクリックします。

BigCommerce への認証

• StoreId：API Path テキストボックスから取得したStore ID に設定。
• OAuthAccessToken：生成したトークンに設定。
• InitiateOAuth：OFF に設定。

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

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

java -jar cdata.jdbc.bigcommerce.jar

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

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

jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.bigcommerce.jar
	driver_class: cdata.jdbc.bigcommerce.BigCommerceDriver
	url: jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'
	table: "Customers"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

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

embulk run bigcommerce-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.bigcommerce.jar
	driver_class: cdata.jdbc.bigcommerce.BigCommerceDriver
	url: jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'
	query: "SELECT FirstName, LastName FROM Customers WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

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

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