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

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

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

Embulk でSurveyMonkey のデータをロード

• CData JDBC Driver for SurveyMonkey をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
  C:\Program Files\CData\CData JDBC Driver for SurveyMonkey 2019J\lib\cdata.jdbc.surveymonkey.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 ファイルを作成し、SurveyMonkey -> MySQL のジョブを作成します。surveymonkey-mysql.yml というファイル名で、以下の内容で作成しました。
in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for SurveyMonkey 2024J\lib\cdata.jdbc.surveymonkey.jar driver_class: cdata.jdbc.surveymonkey.SurveyMonkeyDriver url: jdbc:surveymonkey:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=REFRESH table: "MySurvey_Responses" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "MySurvey_Responses" mode: insert
• JDBC URL の内容は、ご利用の環境や資格情報を入力してください。

  SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。

  SurveyMonkey への接続に使用できる認証方法は2つあります。

  • プライベートoauth アプリケーションを登録するときに、パーソナルアクセストークンを使用します。
  • パブリックoauth アプリケーションを登録するときに、OAuth を使用します。

  パーソナルアクセストークンの使用

  個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、ヘルプの「Creating a Custom OAuth App」の手順に従って、次の接続プロパティを設定します。

  • OAuthAccessToken：アプリケーション設定で生成されたAccessToken に設定。
  • InitiateOAuth：OFF に設定。

  OAuth の使用

  CData 製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。

  独自のカスタムOAuth アプリを使用したい場合は、ヘルプのCustom Credentials を参照してください。

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

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

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

おわりに

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