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

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



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

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

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

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

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

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

    認証

    Webflow は、サイト、CMS コレクション、e コマースデータ、その他のリソースへの安全なアクセスを確保するために、OAuth 2.0 認証を使用します。この認証方式により、Webflow ワークスペースに安全に接続し、適切な認可のもとでリソースを管理できます。

    OAuth 2.0 のセットアップと設定

    ステップ 1:Webflow OAuth アプリケーションの作成

    OAuth 認証をセットアップするには、以下のステップで進めます:

    1. Webflow Developer Portal にアクセスします
    2. Webflow アカウントの「Apps & Integrations」に移動します
    3. 「Register an App」をクリックして新しい OAuth アプリケーションを作成します
    4. アプリケーション名、説明、リダイレクト URI(CallbackURL)を設定します
    5. 接続で使用する Client ID と Client Secret をコピーします

    必須の接続プロパティ

    • AuthScheme:OAuth に設定します(必須)
    • OAuthClientId:Webflow OAuth アプリケーションの Client ID(必須)
    • OAuthClientSecret:Webflow OAuth アプリケーションの Client Secret(必須)
    • CallbackURL:OAuth アプリケーションで指定したリダイレクト URI(必須)
    • InitiateOAuth:トークンを自動管理するには GETANDREFRESH に設定します(推奨)

    必須の OAuth スコープ

    Webflow API プロファイルでは、以下の OAuth スコープが必要です:

    • sites:read - サイト情報および設定への読み取りアクセス
    • pages:read - サイトページへの読み取りアクセス
    • cms:read - CMS コレクションおよびアイテムへの読み取りアクセス
    • forms:read - フォームおよびフォーム送信への読み取りアクセス
    • assets:read - メディアアセットおよびフォルダーへの読み取りアクセス
    • ecommerce:read - 製品、注文、在庫への読み取りアクセス
    • authorized_user:read - 認可されたユーザーへの読み取りアクセス

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

    JDBC 接続文字列URL の作成には、Webflow 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\Webflow.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;").option("dbtable","Sites").option("driver","cdata.jdbc.api.APIDriver").load()
    
  3. 接続が完了し、データがロードされたら、テーブルスキーマが表示されます。
  4. Webflow をテンポラリーテーブルとして登録します:

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

    scala> api_df.sqlContext.sql("SELECT ,  FROM Sites WHERE Id = your_site_id").collect.foreach(println)

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

    Webflow をApache Spark から取得

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

Apache Spark の設定

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

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

Webflow に接続