Azure Cosmos DB for NoSQL SDK を使用して外積クエリの結果をページ分割する

Azure Cosmos DB クエリには、通常、複数の結果ページがあります。改ページは、Azure Cosmos DB から 1 回の実行ですべてのクエリ結果を返せない場合に、自動的にサーバー側で行われます。多くのアプリケーションでは、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 for NoSQL アカウントリソースを作成します。以下を設定して、残りの設定はすべて既定値のままにします。

設定	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 クエリの小さな結果セットで改ページする

クエリ結果を処理するときは、コードが結果のすべてのページを通過し、後続の要求を行う前にこれ以上ページが残っていないかどうかを確認する必要があります。

Visual Studio Code の [エクスプローラー] ペインで、10-paginate-results-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==”; になります。
string 型の sql という名前の新しい変数を SELECT p.id, p.name, p.price FROM products p の値で作成します。
```
 string sql = "SELECT p.id, p.name, p.price FROM products p ";
```
コンストラクターへのパラメーターとして sql 変数を渡す QueryDefinition 型の新しい変数を作成します。
```
 QueryDefinition query = new (sql);
```
既定の空のコンストラクターを使用して、options という名前の QueryRequestOptions 型の新しい変数を作成します。
```
 QueryRequestOptions options = new ();
```
options 変数の MaxItemCount プロパティを、50 の値に設定します。
```
 options.MaxItemCount = 50;
```
query および options 変数をパラメーターとして渡す Container クラスのジェネリック GetItemQueryIterator メソッドを呼び出して、FeedIterator<> 型の iterator という名前の新しい変数を作成します。
```
 FeedIterator<Product> iterator = container.GetItemQueryIterator<Product>(query, requestOptions: options);
```
iterator 変数の HasMoreResults プロパティを確認する while ループを作成します。
```
 while (iterator.HasMoreResults)
 {
        
 }
```
while ループ内で、Product クラスを使用するジェネリック型 FeedResponse の products という名前の変数に結果を格納する iterator 変数の ReadNextAsync メソッドを非同期的に呼び出します。
```
 FeedResponse<Product> products = await iterator.ReadNextAsync();
```
引き続き while ループ内で、Product 型のインスタンスを表すために変数 product を使用する products 変数を反復処理し、新しい foreach ループを作成します。
```
 foreach (Product product in products)
 {

 }
```
foreach ループ内で、組み込みの Console.WriteLine 静的メソッドを使用して、product 変数の id、name、および price プロパティを書式設定して出力します。
```
 Console.WriteLine($"[{product.id}]\t[{product.name,40}]\t[{product.price,10}]");
```
while ループ内に戻り、組み込みの Console.WriteLine 静的メソッドを使用して、Press any key to get more results というメッセージを出力します。
```
 Console.WriteLine("Press any key to get more results");
```
引き続き while ループ内で、組み込みの Console.ReadKey 静的メソッドを使用して、次の keypress 入力をリッスンします。
```
 Console.ReadKey();
```

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

 using System;
 using Microsoft.Azure.Cosmos;

 string endpoint = "<cosmos-endpoint>";

 string key = "<cosmos-key>";

 CosmosClient client = new CosmosClient(endpoint, key);

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

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

 string sql = "SELECT p.id, p.name, p.price FROM products p ";
 QueryDefinition query = new (sql);

 QueryRequestOptions options = new ();
 options.MaxItemCount = 50;

 FeedIterator<Product> iterator = container.GetItemQueryIterator<Product>(query, requestOptions: options);

 while (iterator.HasMoreResults)
 {
     FeedResponse<Product> products = await iterator.ReadNextAsync();
     foreach (Product product in products)
     {
         Console.WriteLine($"[{product.id}]\t[{product.name,40}]\t[{product.price,10}]");
     }

     Console.WriteLine("Press any key for next page of results");
     Console.ReadKey();        
 }

script.cs ファイルを保存します。
Visual Studio Code で、10-paginate-results-sdk フォルダーのコンテキストメニューを開き、[統合ターミナルで開く] を選択して新しいターミナルインスタンスを開きます。
dotnet run コマンドを使用して、プロジェクトをビルドして実行します。
```
 dotnet run
```
これでスクリプトによって、クエリに一致する 50 項目の最初のセットが出力されるようになります。任意のキーを押して、一致するすべての項目に対してクエリが反復処理されるまで、50 項目の次のセットを取得します。

💡 このクエリは、products コンテナー内の数百の項目と一致します。
統合ターミナルを閉じます。
Visual Studio Code を閉じます。