Blazor でLakebase のデータにリアルタイムで連携するアプリを構築
Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。
CData ADO.NET Provider for Lakebase は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってLakebase を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からLakebase に接続して直接SQL クエリを実行する方法を説明します。
CData ADO.NET Provider for Lakebase のインストール
CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL(もしくはDapper などのORM を挟んでもいいです)であり、Lakebase のデータへもRDB と同感覚でアクセスが可能になります。
CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。Lakebase ADO.NET Data Provider で検索してください。
Blazor でLakebase にデータ連携するアプリを構築
Blazor にADO.NET Provider for Lakebase を接続
- Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
- ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
- 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for Lakebase 2019J\lib etstandard2.0」内のSystem.Data.CData.Lakebase.dll」を参照に選びます。
Blazor でLakebase のデータをSELECT
サンプルプロジェクトの「Page」→「Index.razor」を開きます。
以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Lakebase 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for Lakebase の強味です。
@page "/"
@using System.Data;
@using System.Data.CData.Lakebase;
<h1>Hello, world!</h1>
Welcome to your Data app.
<div class="row">
<div class="col-12">
@using (LakebaseConnection connection = new LakebaseConnection(
"DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;"))
{
var sql = "SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'";
var results = new DataTable();
LakebaseDataAdapter dataAdapter = new LakebaseDataAdapter(sql, connection);
dataAdapter.Fill(results);
<table class="table table-bordered">
<thead class="thead-light">
<tr>
@foreach (DataColumn item in results.Rows[0].Table.Columns)
{
<th scope="col">@item.ColumnName</th>
}
</tr>
</thead>
<tbody>
@foreach (DataRow row in results.Rows)
{
<tr>
@foreach (var column in row.ItemArray)
{
<td>@column.ToString()</td>
}
</tr>
}
</tbody>
</table>
}
</div>
</div>
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 クライアントを構成します。手順の概要は以下のとおりです。
- 新しいサービスプリンシパルを作成・構成する
- サービスプリンシパルに権限を割り当てる
- サービスプリンシパル用の OAuth シークレットを作成する
詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。
OAuth PKCE 認証
PKCE(Proof Key for Code Exchange)を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。
- AuthScheme: OAuthPKCE を指定します。
- User: 認証ユーザーのユーザー ID を指定します。
詳細については、ヘルプドキュメントをご参照ください。
プロジェクトをリビルドして実行します。このようにLakebase からデータを直接取得し、HTML テーブル形式にレンダリングしています。
もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。