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

Jerod Johnson
Senior Technology Evangelist

CData JDBC Driver とオープンソースのETL/ELT ツールであるEmbulk を使ってAdobe Commerce のデータをデータベースにロードする方法を解説します。

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

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

Adobe Commerce への JDBC 接続を設定

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

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

Adobe Commerce はOAuth 1 認証標準を使用します。Adobe Commerce REST API に接続するには、Adobe Commerce システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

また、Adobe Commerce システムへのURL を提供する必要があります。URL は、Adobe Commerce REST API を顧客として使用しているか管理者として使用しているかによって異なります。

Customer: Adobe Commerce を顧客として使用するには、事前にAdobe Commerce のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをAdobe Commerce システムのエンドポイントに設定します。
Administrator: Adobe Commerce を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。

このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

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

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

java -jar cdata.jdbc.adobecommerce.jar

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

組み込みの接続文字列デザイナーを使用してJDBC URL を生成（Salesforce の例）

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

jdbc:adobecommerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;

Embulk で Adobe Commerce ののデータをロード

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

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

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

embulk gem install embulk-input-jdbc

この記事では、同期先データベースとして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 を使用してAdobe Commerce のデータをMySQL にロードする準備が整いました。

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.adobecommerce.jar
	driver_class: cdata.jdbc.adobecommerce.AdobeCommerceDriver
	url: jdbc:adobecommerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;
	table: "Products"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Products"
	mode: insert

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

embulk run adobecommerce-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.adobecommerce.jar
	driver_class: cdata.jdbc.adobecommerce.AdobeCommerceDriver
	url: jdbc:adobecommerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;
	query: "SELECT Name, 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 Adobe Commerce をコネクタとして使用することで、Embulk のデータロードジョブにAdobe Commerce のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。