各製品の資料を入手。
詳細はこちら →
製品をチェック
Blazor でCosmos DB のデータにリアルタイムで連携するアプリを構築
ASP.NET Core Blazor C# でCosmos DB にSQL でクエリ。
最終更新日：2021-11-03
この記事で実現できるCosmos DB 連携のシナリオ
こんにちは！リードエンジニアの杉本です。
Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。
CData ADO.NET Provider for CosmosDB は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってCosmos DB を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からCosmos DB に接続して直接SQL クエリを実行する方法を説明します。
CData ADO.NET Provider for CosmosDB のインストール
CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、Cosmos DB のデータへもRDB と同感覚でアクセスが可能になります。
CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。Cosmos DB ADO.NET Data Provider で検索してください。
Blazor でCosmos DB にデータ連携するアプリを構築
Blazor にADO.NET Provider for CosmosDB を接続
- Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
- ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
- 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for CosmosDB 2019J\lib etstandard2.0」内のSystem.Data.CData.CosmosDB.dll」を参照に選びます。
Blazor でCosmos DB のデータをSELECT
サンプルプロジェクトの「Page」→「Index.razor」を開きます。
以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Cosmos DB 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for CosmosDB の強味です。
@page "/"
@using System.Data;
@using System.Data.CData.CosmosDB;
<h1>Hello, world!</h1>
Welcome to your Data app.
<div class="row">
<div class="col-12">
@using (CosmosDBConnection connection = new CosmosDBConnection(
"AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;"))
{
var sql = "SELECT City, CompanyName FROM Customers";
var results = new DataTable();
CosmosDBDataAdapter dataAdapter = new CosmosDBDataAdapter(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>
CosmosDB 接続プロパティの取得・設定方法
SQL API を使ってCosmos DB アカウントに接続するために必要な接続文字列を取得するには、Azure Portal にログインして「Azure Cosmos DB」を選択し、自分のアカウントを選択します。「Settings」セクションで、「Connection String」をクリックして次の値を設定します。
- AccountEndpoint：この値は、Cosmos DB アカウントの「Keys」ブレードからのCosmos DB アカウントURL に設定してください。
- AccountKey：Azure ポータルで、Cosmos DB サービスに移動してAzure Cosmos DB アカウントを選択します。リソースメニューから、 「Keys」ページに移動します。「PRIMARY KEY」値を見つけ、Token をこの値に設定します。
プロジェクトをリビルドして実行します。このようにCosmos DB からデータを直接取得し、HTML テーブル形式にレンダリングしています。
もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。
まとめ
このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってCosmos DB にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。INSERT、UPDATE、DELETE も標準SQL で書くことができます。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。関連コンテンツ
