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

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

API Server の設定

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

Lakebase への接続

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

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

5. Databricks Lakebase に接続するには、以下のプロパティを設定します。

   • DatabricksInstance: Databricks インスタンスまたはサーバーホスト名を指定します。形式は instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com です。
   • Server: Lakebase データベースをホストするサーバーのホスト名または IP アドレスを指定します。
   • Port（オプション）: Lakebase データベースをホストするサーバーのポート番号を指定します。デフォルトは 5432 です。
   • Database（オプション）: Lakebase サーバーへの認証後に接続するデータベースを指定します。デフォルトでは認証ユーザーのデフォルトデータベースに接続します。

   OAuth クライアント認証

   OAuth クライアント資格情報を使用して認証するには、サービスプリンシパルで OAuth クライアントを構成します。手順の概要は以下のとおりです。

   1. 新しいサービスプリンシパルを作成・構成する
   2. サービスプリンシパルに権限を割り当てる
   3. サービスプリンシパル用の OAuth シークレットを作成する

   詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。

   OAuth PKCE 認証

   PKCE（Proof Key for Code Exchange）を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。

   • AuthScheme: OAuthPKCE を指定します。
   • User: 認証ユーザーのユーザー ID を指定します。

   詳細については、ヘルプドキュメントをご参照ください。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Databricks Lakebase に接続するには、以下のプロパティを設定します。

• DatabricksInstance: Databricks インスタンスまたはサーバーホスト名を指定します。形式は instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com です。
• Server: Lakebase データベースをホストするサーバーのホスト名または IP アドレスを指定します。
• Port（オプション）: Lakebase データベースをホストするサーバーのポート番号を指定します。デフォルトは 5432 です。
• Database（オプション）: Lakebase サーバーへの認証後に接続するデータベースを指定します。デフォルトでは認証ユーザーのデフォルトデータベースに接続します。

OAuth クライアント認証

OAuth クライアント資格情報を使用して認証するには、サービスプリンシパルで OAuth クライアントを構成します。手順の概要は以下のとおりです。

1. 新しいサービスプリンシパルを作成・構成する
2. サービスプリンシパルに権限を割り当てる
3. サービスプリンシパル用の OAuth シークレットを作成する

詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。

OAuth PKCE 認証

PKCE（Proof Key for Code Exchange）を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。

• AuthScheme: OAuthPKCE を指定します。
• User: 認証ユーザーのユーザー ID を指定します。

詳細については、ヘルプドキュメントをご参照ください。

API Server のユーザー設定

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

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

Lakebase 用のAPI エンドポイントの作成

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

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

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

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

Node.js からLakebase 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);
});