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

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

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

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

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

• CData JDBC Driver for SurveyMonkey をEmbulk と同じマシンにインストールします。
• 以下のパスに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 2019J\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 の使用

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

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

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

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

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

        
            in:
            type: jdbc
            driver_path: C:\Program Files\CData\CData JDBC Driver for SurveyMonkey 2019J\lib\cdata.jdbc.surveymonkey.jar
            driver_class: cdata.jdbc.surveymonkey.SurveyMonkeyDriver
            url: jdbc:surveymonkey:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=REFRESH
                query: "SELECT RespondentId, ChoiceId FROM MySurvey_Responses WHERE [RecordId] = 1"
            out: 
                type: mysql
                host: localhost
                database: DatabaseName
                user: UserId
                password: UserPassword
                table: "MySurvey_Responses"
                mode: insert
        
    

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