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

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

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

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

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

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

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

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

   まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。

   次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

   その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。

   • AuthScheme：OAuth に設定します。
   • OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
   • OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
   • CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。

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

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

   java -jar cdata.jdbc.api.jar

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

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;").option("dbtable","Deals").option("driver","cdata.jdbc.api.APIDriver").load()
3. 接続が完了し、データがロードされたら、テーブルスキーマが表示されます。

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

   scala> api_df.registerTable("deals")

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

   scala> api_df.sqlContext.sql("SELECT Amount, IssueDate FROM Deals WHERE Id = 1").collect.foreach(println)

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

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