Azure Cosmos DB for NoSQL SDK を使用してクエリを実行する

Azure Cosmos DB for NoSQL 用の .NET SDK の最新バージョンでは、C# の最新のベストプラクティスと言語機能を使用して、コンテナーのクエリと結果セットの非同期反復処理がこれまで以上に簡単になります。

このライブラリには、[https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.cosmos.feediterator?view=azure-dotnet] を使用して Azure Cosmos DB にクエリを実行しやすくするための特別な機能があります。

このラボでは、非同期ストリームを使用して、Azure Cosmos DB for NoSQL から返された大きな結果セットを反復処理します。 .NET SDK を使用して、結果のクエリと反復を行います。

開発環境を準備する

このラボで作業している環境に DP-420 のラボコードのリポジトリをまだクローンしていない場合は、次の手順に従ってクローンします。それ以外の場合は、以前にクローンしたフォルダーを Visual Studio Code で開きます。

Visual Studio Code を起動します。

📝 Visual Studio Code インターフェイスについてまだよく理解していない場合は、Visual Studio Code の入門ガイドを参照してください
コマンドパレットを開き、Git: Clone を実行して、任意のローカルフォルダーに https://github.com/microsoftlearning/dp-420-cosmos-db-dev GitHub リポジトリをクローンします。

💡 Ctrl + Shift + P キーボードショートカットを使用してコマンドパレットを開くことができます。
リポジトリが複製されたら、Visual Studio Code で選択したローカルフォルダーを開きます。

Azure Cosmos DB for NoSQL アカウントを作成する

Azure Cosmos DB は、複数の API をサポートするクラウドベースの NoSQL データベースサービスです。 Azure Cosmos DB アカウントを初めてプロビジョニングするときに、そのアカウントでサポートする API (たとえば、Mongo API や NoSQL API) を選択します。 Azure Cosmos DB for NoSQL アカウントのプロビジョニングが完了したら、エンドポイントとキーを取得し、Azure SDK for .NET または任意の他の SDK を使用して Azure Cosmos DB for NoSQL アカウントに接続する際に使用できます。

新しい Web ブラウザーウィンドウまたはタブで、Azure portal (portal.azure.com) に移動します。
ご利用のサブスクリプションに関連付けられている Microsoft 資格情報を使用して、ポータルにサインインします。

[+ リソースの作成] を選択し、Cosmos DB を検索して、新しい Azure Cosmos DB forNoSQL アカウントリソースを作成します。以下を設定して、残りの設定はすべて既定値のままにします。

設定	Value
サブスクリプション	’‘既存の Azure サブスクリプション’’
リソースグループ	’‘既存のリソースグループを選択するか、新しいものを作成します’’
アカウント名	’‘グローバルに一意の名前を入力します’’
場所	’‘使用可能なリージョンを選びます’’
容量モード	プロビジョニング済みスループット
Apply Free Tier Discount (Free レベル割引の適用)	適用しない

📝 ご利用のラボ環境には、新しいリソースグループを作成できない制限が存在する場合があります。その場合は、事前に作成されている既存のリソースグループを使用します。

デプロイタスクが完了するまで待ってから、このタスクを続行してください。
新しく作成された Azure Cosmos DB アカウントリソースに移動し、 [キー] ペインに移動します。
このペインには、SDK からアカウントに接続するために必要な接続の詳細と資格情報が含まれています。具体的な内容は次のとおりです。
1. [URI] フィールドに注目します。このエンドポイントの値は、この演習で後ほど使用します。
2. [主キー] フィールドに注目してください。このキーの値は、この演習で後ほど使用します。
Visual Studio Code に戻ります。

Azure Cosmos DB for NoSQL アカウントにデータをシードする

cosmicworks コマンドラインツールを使用して、Azure Cosmos DB for NoSQL アカウントにサンプルデータをデプロイします。このツールはオープンソースで、NuGet から入手できます。このツールを Azure Cloud Shell にインストールして、データベースのシードに使用します。

Visual Studio Code で、 [ターミナル] メニューを開き、 [新しいターミナル] を選択して新しいターミナルインスタンスを開きます。
コンピューターでグローバルに使用するために cosmicworks コマンドラインツールをインストールします。
```
 dotnet tool install cosmicworks --global --version 1.*
```
💡 このコマンドが完了するまで数分かかる場合があります。過去にこのツールの最新バージョンを既にインストールしている場合は、このコマンドによって警告メッセージ (*ツール ‘cosmicworks’ は既にインストールされています) が出力されます。

cosmicworks を実行し、次のコマンドラインオプションを使用して Azure Cosmos DB アカウントをシードします。

オプション	Value
–endpoint	’‘このラボで先ほどコピーしたエンドポイントの値’’
–key	’‘このラボで先ほどコピーしたキーの値’’
–datasets	product

 cosmicworks --endpoint <cosmos-endpoint> --key <cosmos-key> --datasets product

📝 たとえば、エンドポイントが https://dp420.documents.azure.com:443/ で、キーが fDR2ci9QgkdkvERTQ== の場合、コマンドは次のようになります。cosmicworks --endpoint https://dp420.documents.azure.com:443/ --key fDR2ci9QgkdkvERTQ== --datasets product

cosmicworks コマンドによって、データベース、コンテナー、および項目がアカウントに設定されるまで待ちます。
統合ターミナルを閉じます。

SDK を使用して SQL クエリの結果を反復処理する

ここでは、非同期ストリームを使用して、Azure Cosmos DB でのページ分割された結果に対して、わかりやすい foreach ループを作成します。バックグラウンドでは、SDK でフィード反復子を管理し、後続の要求が正しく呼び出されるようにします。

Visual Studio Code の [エクスプローラー] ペインで、09-execute-query-sdk フォルダーを参照します。
product.cs コードファイルを開きます。
Product クラスとその対応するプロパティを確認します。具体的には、このラボでは id、name、および price プロパティが使用されます。
Visual Studio Code の [エクスプローラー] ペインに戻り、script.cs コードファイルを開きます。
endpoint という名前の既存の変数を、先ほど作成した Azure Cosmos DB アカウントの endpoint に設定された値で更新します。
```
 string endpoint = "<cosmos-endpoint>";
```
📝 たとえば、ご自分のエンドポイントが https://dp420.documents.azure.com:443/ の場合、C# ステートメントは string endpoint = “https://dp420.documents.azure.com:443/”; になります。
key という名前の既存の変数を、先ほど作成した Azure Cosmos DB アカウントの key に設定された値で更新します。
```
 string key = "<cosmos-key>";
```
📝 たとえば、キーが fDR2ci9QgkdkvERTQ== の場合、C# ステートメントは string key = “fDR2ci9QgkdkvERTQ==”; になります。
script.cs ファイルの末尾に新しいコードを追加して、string 型で値が SELECT * FROM products p である sql という新しい変数を作成しましょう。
```
 string sql = "SELECT * FROM products p";
```
コンストラクターへのパラメーターとして sql 変数を渡す QueryDefinition 型の新しい変数を作成します。
```
 QueryDefinition query = new (sql);
```
CosmosContainer クラスの汎用 GetItemQueryIterator メソッドを呼び出して、query 変数をパラメーターとして渡すことにより、新しい while ループを作成し、結果を反復処理します。
```
 using FeedIterator<Product> feed = container.GetItemQueryIterator<Product>(
     queryDefinition: query
 );

 while (feed.HasMoreResults)
 {
 }
```
while ループ内で、次の結果を非同期で読み取り、組み込みの Console.WriteLine 静的メソッドを使用して、product 変数の id、name、price プロパティを書式設定して出力します
```
 FeedResponse<Product> response = await feed.ReadNextAsync();
 foreach (Product product in response)
 {
     Console.WriteLine($"[{product.id}]\t{product.name,35}\t{product.price,15:C}");
 }
```

完了すると、コードファイルが次のようになるはずです。

 using System;
 using Microsoft.Azure.Cosmos;

 string endpoint = "<cosmos-endpoint>";

 string key = "<cosmos-key>";

 CosmosClient client = new (endpoint, key);

 Database database = await client.CreateDatabaseIfNotExistsAsync("cosmicworks");

 Container container = await database.CreateContainerIfNotExistsAsync("products", "/categoryId");

 string sql = "SELECT * FROM products p";
 QueryDefinition query = new (sql);

 using FeedIterator<Product> feed = container.GetItemQueryIterator<Product>(
     queryDefinition: query
 );

 while (feed.HasMoreResults)
 {
     FeedResponse<Product> response = await feed.ReadNextAsync();
     foreach (Product product in response)
     {
         Console.WriteLine($"[{product.id}]\t{product.name,35}\t{product.price,15:C}");
     }
 }

script.cs ファイルを保存します。
Visual Studio Code で、09-execute-query-sdk フォルダーのコンテキストメニューを開き、[統合ターミナルで開く] を選択して新しいターミナルインスタンスを開きます。
次のコマンドを使用して、NuGet から Microsoft.Azure.Cosmos (nuget.org/packages/microsoft.azure.cosmos/3.22.1) パッケージを追加します。
```
 dotnet add package Microsoft.Azure.Cosmos --version 3.22.1
```
dotnet run コマンドを使用して、プロジェクトをビルドして実行します。
```
 dotnet run
```
これで、スクリプトによって、コンテナー内のすべての製品が出力されます
統合ターミナルを閉じます。
Visual Studio Code を閉じます。