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

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

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

Embulk でWooCommerce のデータをロード

• CData JDBC Driver for WooCommerce をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
• 以下のパスに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 2024J\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 は、one-legged OAuth1.0 認証と通常のOAuth2.0 認証をサポートします。

  one-legged OAuth 1.0 認証を使って接続する

  次のプロパティを指定してください（NOTE：次の資格情報はWooCommerce の設定ページで生成されるもので、WordPress OAuth2.0 プラグインで生成されるものとは異なります）。

  • ConsumerKey
  • ConsumerSecret

  WordPress OAuth 2.0 認証を使って接続する

  プラグインを設定した後、 次の接続プロパティを指定することでWooCommerce に接続できます。

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL
  • InitiateOAuth - GETANDREFRESH または REFRESH のどちらかに設定してください

  どちらの場合方法でも、Url プロパティをWooCommerce インスタンスのURL に設定する必要があります。

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

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

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

おわりに

CData JDBC Driver for WooCommerce をEmbulk で使うことで、WooCommerce と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。