Node.js からSQL Server のデータをクエリ

CData API Server とADO.NET Provider for SQL(もしくは250+ の他のADO.NET Providers)を使って、SQL Server をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたSQL Server のデータをNode.js でリクエストする方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSQL Server OData サービスを作成していきましょう。

SQL Server への接続

NodeJS からSQL Server のデータを操作するには、まずSQL Server への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SQL Server」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、SQL Server への接続設定を行っていきましょう！

5. SQL Server 接続プロパティの取得・設定方法

   Microsoft SQL Server への接続には以下を入力します。

   • Server: SQL Server が稼働するサーバー名。
   • User: SQL Server に接続するユーザー名。
   • Password: 接続するユーザーのパスワード。
   • Database: SQL Server データベース名。

   Azure SQL Server およびAzure Data Warehouse への接続

   Azure SQL Server およびAzure Data Warehouse には以下の接続プロパティを入力して接続します:

   • Server: Azure 上のサーバー。Azure ポータルの「SQL databases」（もしくは「SQL data warehouses」）-> データベースを選択 -> 「Overview」-> 「Server name」で確認が可能です。
   • User: Azure に認証するユーザー名。
   • Password: 認証するユーザーのパスワード。
   • Database: Azure ポータルでSQL databases (or SQL warehouses) ページに表示されるデータベース名。
6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

SQL Server 接続プロパティの取得・設定方法

Microsoft SQL Server への接続には以下を入力します。

• Server: SQL Server が稼働するサーバー名。
• User: SQL Server に接続するユーザー名。
• Password: 接続するユーザーのパスワード。
• Database: SQL Server データベース名。

Azure SQL Server およびAzure Data Warehouse への接続

Azure SQL Server およびAzure Data Warehouse には以下の接続プロパティを入力して接続します:

• Server: Azure 上のサーバー。Azure ポータルの「SQL databases」（もしくは「SQL data warehouses」）-> データベースを選択 -> 「Overview」-> 「Server name」で確認が可能です。
• User: Azure に認証するユーザー名。
• Password: 認証するユーザーのパスワード。
• Database: Azure ポータルでSQL databases (or SQL warehouses) ページに表示されるデータベース名。

API Server のユーザー設定

次に、API Server 経由でSQL Server にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

SQL Server 用のAPI エンドポイントの作成

ユーザーを作成したら、SQL Server のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でSQL Server への接続を設定してユーザーを作成し、API Server でSQL Server データのAPI を追加しました。これで、OData 形式のSQL Server データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Node.js からSQL Server OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはOrders データに対して認証されたリクエストを行います。 以下のURL の例では、ShipCountry カラムの値がUSA のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Orders?$filter=" + encodeURIComponent("ShipCountry eq 'USA'"),
  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);
});