Mule アプリケーションからREST データにアクセス：CData JDBC Driver

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for REST はREST データをMule アプリケーションと連携することで、読み、書き、更新、削除といった機能をおなじみのSQL クエリを使って実現します。JDBC ドライバーを使えば、REST データをバックアップ、変換、レポート作成、分析するMule アプリケーションをユーザーは簡単に作成できます。

本記事では、Mule プロジェクト内でCData JDBC Driver for REST を使用して、REST データのWeb インターフェースを作成する方法を紹介します。作成したアプリケーションを使えば、HTTP 経由でREST データをリクエストして、JSON 形式で結果を取得できます。まったく同様の手順で、すべてのCData JDBC ドライバで240 を超えるデータソースのWeb インターフェースを作成できます。手順は以下のとおりです。

1. Anypoint Studio で新しいMule プロジェクトを作る。
2. Message Flow にHTTP コネクタを追加する。
3. HTTP コネクタのアドレスを設定する。
4. HTTP コネクタの追加後、Database Select コネクタを同じフローに追加する。
5. データベースへの新しい接続を作成し（または既存の接続を編集し）、プロパティを設定する。
   • 接続を「Generic Connection」に設定
   • Required Libraries セクションでCData JDBC ドライバのJAR ファイルを指定する(例：cdata.jdbc.rest.jar)。
   • REST の接続文字列にURL を指定

     データソースへの認証については、データプロバイダーのヘルプドキュメントの「はじめに」を参照してください: データプロバイダーはREST API を双方向データベーステーブルとして、XML/JSON ファイル（ローカルファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー）を読み取り専用のビューとしてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。認証についての詳細は、ヘルプドキュメントの「はじめに」を参照してください。

     URI を設定し、認証値を指定したら、Format を"XML" または"JSON" に設定して、データ表現をデータ構造により厳密に一致させるようにDataModel を設定します。

     DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、以下の基本的な設定を切り替えます。

     • Document （デフォルト）：REST データのトップレベルのドキュメントビューをモデル化します。データプロバイダーはネストされたエレメントをデータの集計として返します。
     • FlattenedDocuments：ネストされたドキュメントとその親を単一テーブルとして暗黙的に結合します。
     • Relational：階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれます。

     リレーショナル表現の構成について詳しくは、「REST データのモデル化」を参照してください。次の例で使用されているサンプルデータもあります。データには、人、所有している車、およびそれらの車で行われたさまざまなメンテナンスサービスのエントリが含まれています。The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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

     JDBC 用のURL の作成にサポートが必要な場合は、REST JDBC Driver に組み込まれた接続文字列デザイナを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行してください。

     java -jar cdata.jdbc.rest.jar

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

   • Driver クラス名をcdata.jdbc.rest.RESTDriver に指定します。
   • 「接続テスト」をクリックします。
6. SQL Query Text をREST データをリクエストするためのSQL クエリに設定します。例えば、SELECT [people].[personal.age] AS age, [people].[personal.gender] AS gender, [people].[personal.name.first] AS first_name, [people].[personal.name.last] AS last_name, [vehicles].[model], FROM [people] JOIN [vehicles] ON [people].[_id] = [vehicles].[people_id]。
7. Transform Message コンポーネントをフローに追加します。
8. Output スクリプトを次のように設定して、ペイロードをJSON に変換します。

   %dw 2.0
   output application/json
   ---
   payload
           

9. REST データを閲覧するには、HTTP コネクタ用に設定したアドレスに移動します（デフォルトでは、localhost:8081）：http://localhost:8081。Web ブラウザおよびJSON エンドポイントを使用可能な他のツール内で、REST データをJSON として利用できます。

これで、カスタムアプリケーションおよび他のさまざまなBI、帳票、ETL ツールからREST データを（JSON データとして）扱うための簡易なWeb インターフェースを作成できました。Mule アプリケーションからお好みのデータソースにアクセスできる、JDBC Driver for REST の30日の無償評価版のダウンロードはこちらから。