ETL/ELT のEmbulk を使ってPonparemall データをDB にロードする方法

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

Embulk でCData JDBC Driver for Ponparemall データをロード

• CData JDBC Driver for Ponparemall をEmbulk と同じマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
  C:\Program Files\CData\CData JDBC Driver for Ponparemall 2019J\lib\cdata.jdbc.ponparemall.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 ファイルを作成し、Ponparemall -> MySQL のジョブを作成します。ponparemall-mysql.yml というファイル名で作成しました。

            
                in:
                    type: jdbc
                    driver_path: C:\Program Files\CData\CData JDBC Driver for Ponparemall 2019J\lib\cdata.jdbc.ponparemall.jar
                    driver_class: cdata.jdbc.ponparemall.PonparemallDriver
                    url: jdbc:ponparemall:InventoryUserId=Inventory UserId;InventoryPassword=Invetory Password;
                    table: "Orders"
                out: 
                    type: mysql
                    host: localhost
                    database: DatabaseName
                    user: UserId
                    password: UserPassword
                    table: "Orders"
                    mode: insert
            
        

• ポイントはJDBC URLです。

  Ponparemall に接続するには、ShopUrl、InventoryUserId、InventoryPassword、OrderUserId、OrderPassword、PaymentUserId、およびPaymentPassword が必要です。

  Ponparemall へのアクセスの設定

  Ponparemall には各API のId とPassword が必要です。取得するには、以下の手順に従ってください。

  • Ponparemall Manager にログインし、メニューの「各種申請」の「WebAPI利用申請」をクリックします。
  • Web API メニューの「WebAPIサービス利用申請」をクリックし、利用申請を行います。
  • 後日、Ponparemall から必要なId とPassword が送られてきます。

  Ponparemall アカウントの認証

  次の接続プロパティを設定して接続します。

  • ShopUrl：接続先のPonparemall Shop URL を設定。「http://storetst4.ponparemall.com/sample/」に含まれる「sample」の部分を入力します。
  • InventoryUserId：「在庫API」のユーザID を設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
  • InventoryPassword：「在庫API」のパスワードを設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
  • OrderUserId：「受注API」のユーザID を設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
  • OrderPassword：「受注API」のパスワードを設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
  • PaymentUserId：「決済API」のユーザID を設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。
  • PaymentPassword：「決済API」のパスワードを設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。
• テーブル名は取得したいテーブル名を入れます。
• これで準備完了です。あとは「embulk run」で実行するだけです。
embulk run ponparemall-mysql.yml
• 実行後、MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

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

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

        
            in:
            type: jdbc
            driver_path: C:\Program Files\CData\CData JDBC Driver for Ponparemall 2019J\lib\cdata.jdbc.ponparemall.jar
            driver_class: cdata.jdbc.ponparemall.PonparemallDriver
            url: jdbc:ponparemall:InventoryUserId=Inventory UserId;InventoryPassword=Invetory Password;
                query: "SELECT OrderNumber, OrderStatus FROM Orders WHERE [RecordId] = 1"
            out: 
                type: mysql
                host: localhost
                database: DatabaseName
                user: UserId
                password: UserPassword
                table: "Orders"
                mode: insert
        
    

CData JDBC Driver for Ponparemall をEmbulk で使うことで、Ponparemall コネクタとして機能し、簡単にデータを取得して同期することができました。ぜひ、30日の無償評価版をお試しください。