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 には、接続および認証する2つの方法があります。Basic およびOAuth です。

   Basic 認証

   Basic 認証で認証するには：
   1. API トークンを取得します。
      1. Pipedrive ポータルを開きます。
      2. ページ右上のアカウント名をクリックします。Pipedrive はドロップダウンリストを表示します。
      3. 会社設定 -> Personal Preferences -> API -> Generate Token に移動します。
      4. 生成されたAPI トークンの値を記録します。また、CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。（これは会社の開発者用サンドボックスのURL です。）
   2. 次の接続プロパティを設定します。
      • APIToken：取得したAPI トークンの値。
      • CompanyDomain：開発者サンドボックスURL のCompanyDomain。
      • AuthScheme：Basic。
   3. 承認されたユーザー名とパスワードでログインします。

   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日の無償評価版 をダウンロードしてぜひお試しください。

Apache Spark の設定