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

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

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

スマレジ への JDBC 接続を設定

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

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

スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。

• スマレジにログイン後、「設定」->「システム連携」->「スマレジAPI 設定」に移動します。
• 「API受信設定」セクションにある「受信機能を利用する」を「利用する」に変更し、「アクセストークンの生成」をクリックし、AccessToken を取得します。
• 次に必要なAPI アクセスを有効にするため、「機能設定」セクションで必要な機能を「利用する」に変更します。

ContractId： アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken： 受信設定セクションのアクセストークン。

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

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

java -jar cdata.jdbc.smaregi.jar

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

以下は、スマレジ への一般的なJDBC 接続文字列です。

jdbc:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;

Embulk で スマレジ ののデータをロード

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

スマレジ ののデータをロードするジョブを作成

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.smaregi.jar
	driver_class: cdata.jdbc.smaregi.SmaregiDriver
	url: jdbc:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;
	table: "Products"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Products"
	mode: insert

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

embulk run smaregi-mysql.yml

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

フィルタリングした スマレジ ののデータをロード

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.smaregi.jar
	driver_class: cdata.jdbc.smaregi.SmaregiDriver
	url: jdbc:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;
	query: "SELECT ProductName, Description FROM Products WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Products"
	mode: insert

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

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