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

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

※製品について詳しい情報をご希望の方は以下からお進みください。

• WooCommerce にほかのBI、ETL、開発ツールから接続したい：WooCommerce データ連携ガイドおよびチュートリアルのリストへ
• WooCommerce Drivers について詳細を知りたい：ドライバー詳細情報ページへ
• ほかのデータソースに連携したい：CData Drivers 一覧へ
• ドライバーの30日の無償トライアル版を使いたい：トライアル版ダウンロードページへ
• 製品の利用やライセンスについて相談したい：sales@cdata.co.jp までメールにてご相談ください。

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

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

            
                in:
                    type: jdbc
                    driver_path: C:\Program Files\CData\CData JDBC Driver for WooCommerce 2019J\lib\cdata.jdbc.woocommerce.jar
                    driver_class: cdata.jdbc.woocommerce.WooCommerceDriver
                    url: jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=REFRESH
                    table: "Orders"
                out: 
                    type: mysql
                    host: localhost
                    database: DatabaseName
                    user: UserId
                    password: UserPassword
                    table: "Orders"
                    mode: insert
            
        

• ポイントはJDBC URLです。

  WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

  Connecting using one-legged OAuth 1.0 Authentication

  Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

  • ConsumerKey
  • ConsumerSecret

  Connecting using WordPress OAuth 2.0 Authentication

  After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL
  • InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

  In either case, you will need to set the Url property to the URL of the WooCommerce instance.

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

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

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

        
            in:
            type: jdbc
            driver_path: C:\Program Files\CData\CData JDBC Driver for WooCommerce 2019J\lib\cdata.jdbc.woocommerce.jar
            driver_class: cdata.jdbc.woocommerce.WooCommerceDriver
            url: jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=REFRESH
                query: "SELECT ParentId, Total FROM Orders WHERE [RecordId] = 1"
            out: 
                type: mysql
                host: localhost
                database: DatabaseName
                user: UserId
                password: UserPassword
                table: "Orders"
                mode: insert
        
    

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