Apache Spark でPipedrive データをSQL で操作する方法

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

Apache Spark は大規模データ処理のための高速エンジンです。CData JDBC Driver for Pipedrive と組み合わせると、Spark はリアルタイムでPipedrive データに連携して処理ができます。本記事では、Spark シェルに接続してPipedrive をクエリする方法について解説します。

CData JDBC Driver は、最適化されたデータ処理がドライバーに組み込まれているため、リアルタイムPipedrive と対話するための高いパフォーマンスを提供します。Pipedrive に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計など、サポートされているSQL操作を直接Pipedrive にプッシュし、組込みSQL エンジンを使用してサポートされていない操作（SQL 関数やJOIN 操作）をクライアント側で処理します。組み込みの動的メタデータクエリを使用すると、ネイティブデータ型を使用してPipedrive を操作して分析できます。

CData JDBC Driver for Pipedrive をインストール

まずは、本記事右側のサイドバーからPipedrive JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

Spark Shell を起動してPipedrive データに接続

1. ターミナルを開き、Spark shell でCData JDBC Driver for Pipedrive JAR file をjars パラメータに設定します: $ spark-shell --jars /CData/CData JDBC Driver for Pipedrive/lib/cdata.jdbc.pipedrive.jar
2. Shell でJDBC URL を使ってPipedrive に接続し、SQL Context load() function でテーブルを読み込みます。

   Pipedrive 接続プロパティの取得・設定方法

   Pipedrive への接続に使用できる認証方法は、Basic およびOAuth です。

   Basic

   API トークンの取得から始めます。
   1. PipeDrive の右上にあるアカウント名をクリックします。
   2. 会社設定をクリックし、続いてPersonal Preferences -> API -> Generate Token をクリックします。
   3. API トークンを控えておきます。
   4. CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。

   以下を設定してPipedrive へ認証します。

   • APIToken：控えておいたAPI トークンに設定。
   • CompanyDomain：控えておいた開発者サンドボックスURL の会社ドメインに設定。
   • AuthScheme：Basic に設定。

   API トークンは、PipeDrive の右上にあるアカウント名 -> 会社設定 -> Personal preferences -> API に移動して確認できます。

   OAuth

   ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

   組み込みの接続文字列デザイナー

   JDBC 接続文字列URL の作成には、Pipedrive JDBC Driver にビルトインされたデザイナを使用できます。JAR ファイルをダブルクリックするか、コマンドラインでJAR ファイルを実行するとデザイナが開きます。

   java -jar cdata.jdbc.pipedrive.jar

   接続プロパティを入力し、接続文字列をクリップボードにコピーします。

   scala> val pipedrive_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;").option("dbtable","Deals").option("driver","cdata.jdbc.pipedrive.PipedriveDriver").load()
3. 接続が完了し、データがロードされたら、テーブルスキーマが表示されます。

4. Pipedrive をテンポラリーテーブルとして登録します:

   scala> pipedrive_df.registerTable("deals")

5. データに対して、次のようなカスタムSQL クエリを実行します。

   scala> pipedrive_df.sqlContext.sql("SELECT PersonName, UserEmail FROM Deals WHERE Value = 50000").collect.foreach(println)

   コンソールで、次のようなPipedrive データを取得できました！これでPipedrive との連携は完了です。

CData JDBC Driver for Pipedrive をApache Spark で使って、Pipedrive に対して、複雑かつハイパフォーマンスなクエリを実行できます。30日の無償評価版 をダウンロードしてぜひお試しください。