製品をチェック

Smaregi Driver の30日間無償トライアルをダウンロード

 30日間の無償トライアルへ

製品の詳細

Smaregi アイコン Smaregi JDBC Driver 相談したい

商品、在庫、発送状況などのスマレジアカウントデータを組み込んだ強力なJava アプリケーションを迅速に作成して配布できます。

ETL ツールのEmbulk を使ってスマレジ のデータをDB にロードする方法

OSS のETL ツールEmbulk のJDBC Plugin を使って、スマレジ のデータを簡単にDB に同期する方法をご紹介します。

杉本和也
リードエンジニア

最終更新日:2023-10-13
smaregi ロゴ

CData

jdbc ロゴ画像
Embulk ロゴ

こんにちは!リードエンジニアの杉本です。

Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for Smaregi を使って、スマレジ のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。

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

  • CData JDBC Driver for Smaregi をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
  • 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
    C:\Program Files\CData\CData JDBC Driver for Smaregi 2019J\lib\cdata.jdbc.smaregi.jar
  • 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。

    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

    インストール用のコマンドはこちら:

    embulk gem install embulk-input-jdbc
  • 今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。

    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

    コマンドはこちら。

    embulk gem install embulk-output-mysql
  • config ファイルを作成し、スマレジ -> MySQL のジョブを作成します。smaregi-mysql.yml というファイル名で、以下の内容で作成しました。
  • in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Smaregi 2024J\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
  • JDBC URL の内容は、ご利用の環境や資格情報を入力してください。

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

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

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

  • テーブル名は取得したいテーブル名を入れます。
  • これで準備完了です。あとは「embulk run」で実行するだけです。
  • embulk run smaregi-mysql.yml
  • 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

クエリ条件でフィルタリングしたデータのロード

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Smaregi 2019J\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 で使うことで、スマレジ と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。