Node.js からCouchDB のデータをクエリ
CData API Server とADO.NET Provider for ApacheCouchDB(もしくは250+ の他のADO.NET Providers)を使って、CouchDB をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたCouchDB のデータをNode.js でリクエストする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなCouchDB OData サービスを作成していきましょう。
CouchDB への接続
NodeJS から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 のエンドポイントを表示およびコピーできます。
Node.js からCouchDB OData フィードを利用
OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。
以下のコードはMovies データに対して認証されたリクエストを行います。 以下のURL の例では、MovieRating カラムの値がR のレコードを検索する単純なフィルターを適用しています。
var http = require('http');
http.get({
protocol: "http:",
hostname:"MyServer.com",
port:MyPort,
path: "/api.rsc/Movies?$filter=" + encodeURIComponent("MovieRating eq 'R'"),
auth:'MyUser:MyAuthtoken'
},
function(res) {
var body = '';
res.on('data', function(chunk) {
body += chunk;
});
res.on('end', function() {
console.log(body);
var jsonData = JSON.parse(body);
});
}).on('error', function(e) {
console.log("Error: ", e);
});