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

杉本和也
杉本和也
リードエンジニア
CData JDBC ドライバーを使用して、Apache Spark でApprovalMax にデータ連携。



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

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

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

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

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

  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 を使ってApprovalMax に接続し、SQL Context load() function でテーブルを読み込みます。

    まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します(例:C:\profiles\ApprovalMax.apip)。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します(以下を参照)。

    ApprovalMax API プロファイル設定

    ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

    まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal(https://developer.approvalmax.com/applications)にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI(Callback URL)を少なくとも1つ登録しておく必要があります。

    Public API を利用するには、ApprovalMax の Premium サブスクリプション(または有効なトライアル)が必要です。

    以下の接続プロパティを設定すると、接続できるようになります。

    • AuthScheme:OAuth に設定します。
    • InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId:ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
    • OAuthClientSecret:ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
    • CallbackURL:アプリケーション設定で登録した Redirect URI に設定します。
    • Scope:(オプション)デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

    OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

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

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

    
    java -jar cdata.jdbc.api.jar
    

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

    
    scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\ApprovalMax.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;").option("dbtable","UserProfiles").option("driver","cdata.jdbc.api.APIDriver").load()
    
  3. 接続が完了し、データがロードされたら、テーブルスキーマが表示されます。
  4. ApprovalMax をテンポラリーテーブルとして登録します:

    scala> api_df.registerTable("userprofiles")
  5. データに対して、次のようなカスタムSQL クエリを実行します。

    scala> api_df.sqlContext.sql("SELECT UserId, Email FROM UserProfiles WHERE CompanyId = 00000000-0000-0000-0000-000000000000").collect.foreach(println)

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

    ApprovalMax をApache Spark から取得

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

Apache Spark の設定

はじめる準備はできましたか?

API Driver で ApprovalMax のライブデータに接続

ApprovalMax に接続