データ可視化ソリューション「Reveal」から CouchDB に接続する方法
CData API Server を使って、Reveal にCouchDB データをフィードして、ビジュアライズを実現できます。コネクターによりリアルタイムデータ連携が可能になり、リフレッシュ操作で最新のデータを取得可能になります。この記事では、Reveal からCouchDB のデータに接続しビジュアライズする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなCouchDB OData サービスを作成していきましょう。
CouchDB への接続
Reveal からCouchDB のデータを操作するには、まずCouchDB への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「CouchDB」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、CouchDB への接続設定を行っていきましょう！
-
Apache CouchDB 接続プロパティの取得・設定方法
それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984
ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。
Apache CouchDB への認証
続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。
- Basic：基本的なユーザー名 / パスワード認証
- JWT：JWT 認証
- None：パブリックなデータベースへの匿名アクセス
Basic 認証
データに接続するには、以下のプロパティを設定してください。
- AuthScheme：Basic
- User：認証に使用されるApache CouchDB ユーザーアカウント
- Password：認証するユーザーに関連付けられたApache CouchDB パスワード
その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Apache CouchDB 接続プロパティの取得・設定方法
それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984
ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。
Apache CouchDB への認証
続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。
- Basic：基本的なユーザー名 / パスワード認証
- JWT：JWT 認証
- None：パブリックなデータベースへの匿名アクセス
Basic 認証
データに接続するには、以下のプロパティを設定してください。
- AuthScheme：Basic
- User：認証に使用されるApache CouchDB ユーザーアカウント
- Password：認証するユーザーに関連付けられたApache CouchDB パスワード
その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。
API Server のユーザー設定
次に、API Server 経由でCouchDB にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
CouchDB 用のAPI エンドポイントの作成
ユーザーを作成したら、CouchDB のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でCouchDB への接続を設定してユーザーを作成し、API Server でCouchDB データのAPI を追加しました。これで、OData 形式のCouchDB データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
ダッシュボードの作成
それでは実際に可視化を行っていきます。「Reveal」ではダッシュボードという単位でいくつかのグラフを配置して、構成していきます。
- Revealにログインし、「新規」→「ダッシュボード」をクリックします。
- データソースから「ODataフィード」を選択し
- API ServerのAPIエンドポイントURLを指定し、資格情報を入力します。 URLは「https://XXXXXXX/api.rsc/」といったように末尾が「api.rsc」で終わっているものを入力します。
- 資格情報は「汎用資格情報」を選択し、
- あらかじめ作成しておいたAPI Serverのユーザー名と認証トークンをそれぞれ指定します。
- 認証完了後、エンティティセットを選択する画面に移動するので、取得したい任意のエンティティセットを選択します。
- これでダッシュボードを作成する準備が整いました。あとは Reveal の機能を使って、CouchDB・API Serverから取得したデータを可視化・分析することができます。
- 以下のようなグラフを作成することができました。
このように CouchDB 内のデータをAPI を書くことなく Reveal 上で処理することができるようになります。
おわりに
これで、リアルタイムCouchDB のデータから簡単なダッシュボードが作成できました。CouchDB （および150 を超えるほかのソース）からのOData フィードの作成方法の詳細については、API Server のページにアクセスしてください。30 日間無料トライアルをダウンロードしてOData API を使用するツールでCouchDB のデータをリアルタイムに活用しましょう。