一般的な操作に対して Azure Cosmos DB for NoSQL コンテナーのインデックス作成ポリシーを最適化する

書き込みの多いワークロードや大きな JSON オブジェクトを扱うワークロードでは、インデックス作成ポリシーをクエリで使用したいことがわかっているプロパティのインデックスのみを作成するように最適化すると都合が良い場合があります。

このラボでは、テスト用の .NET アプリケーションを使って Azure Cosmos DB for NoSQL コンテナーに大きな JSON 項目を挿入します。その際、既定のインデックス作成ポリシーを使用し、次に、少し調整したインデックス作成ポリシーを使用します。

開発環境を準備する

このラボで作業している環境に DP-420 のラボコードのリポジトリをまだクローンしていない場合は、次の手順に従ってクローンします。それ以外の場合は、以前にクローンしたフォルダーを 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 サブスクリプション’’
リソースグループ	’‘既存のリソースグループを選択するか、新しいものを作成します’’
アカウント名	’‘グローバルに一意の名前を入力します’’
場所	’‘使用可能なリージョンを選びます’’
容量モード	サーバーレス

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

デプロイタスクが完了するまで待ってから、このタスクを続行してください。
新しく作成された Azure Cosmos DB アカウントリソースにアクセスし、[データエクスプローラー] ペインに移動します。
[データエクスプローラー] ペインで、 [新しいコンテナー] を選択します。

[新しいコンテナー] ポップアップで、各設定に次の値を入力してから [OK] を選択します。

設定	Value
データベース ID	新規作成 \| `cosmicworks`
コンテナー ID	`products`
パーティションキー	`/categoryId`

[データエクスプローラー] ペインに戻り、cosmicworks データベースノードを展開して、階層内の products コンテナーノードを確認します。
リソースブレードで、[キー] ペインに移動します。
このペインには、SDK からアカウントに接続するために必要な接続の詳細と資格情報が含まれています。具体的な内容は次のとおりです。
1. [URI] フィールドに注目します。このエンドポイントの値は、この演習で後ほど使用します。
2. [主キー] フィールドに注目してください。このキーの値は、この演習で後ほど使用します。
Visual Studio Code に戻ります。

既定のインデックス作成ポリシーを使用してテスト用の .NET アプリケーションを実行する

このラボでは、大きな JSON オブジェクトを受け取り、Azure Cosmos DB for NoSQL コンテナーに新しい項目を作成するテスト用の .NET アプリケーションが事前構築されています。 1 回の書き込み操作が完了すると、このアプリケーションから、項目の一意識別子と RU 料金がコンソールウィンドウに出力されます。

[エクスプローラー] ウィンドウで、23-index-optimization フォルダーを参照します。
23-index-optimization フォルダーのコンテキストメニューを開き、[統合ターミナルで開く] を選択して新しいターミナルインスタンスを開きます。

📝 このコマンドを実行すると、ターミナルが開き、開始ディレクトリが既に 23-index-optimization フォルダーに設定されています。
[dotnet build][docs.microsoft.com/dotnet/core/tools/dotnet-build] コマンドを使用してプロジェクトをビルドします。
```
 dotnet build
```
📝 コンパイラから、endpoint および key 変数は現在使用されていないという警告が表示される場合があります。これらの変数はこのタスクで使用しますので、この警告は無視しても問題ありません。
統合ターミナルを閉じます。
script.cs コードファイルを開きます。
endpoint という名前の string 変数を見つけます。その値を、先ほど作成した Azure Cosmos DB アカウントのエンドポイントに設定します。
```
 string endpoint = "<cosmos-endpoint>";
```
📝 たとえば、ご自分のエンドポイントが https://dp420.documents.azure.com:443/ の場合、C# ステートメントは string endpoint = “https://dp420.documents.azure.com:443/”; になります。
key という名前の string 変数を見つけます。その値を、先ほど作成した Azure Cosmos DB アカウントのキーに設定します。
```
 string key = "<cosmos-key>";
```
📝 たとえば、キーが fDR2ci9QgkdkvERTQ== の場合、C# ステートメントは string key = “fDR2ci9QgkdkvERTQ==”; になります。
script.cs コードファイルを保存します。
Visual Studio Code,で 23-index-optimization フォルダーのコンテキストメニューを開き、[統合ターミナルで開く] を選択して新しいターミナルインスタンスを開きます。
dotnet run コマンドを使用して、プロジェクトをビルドして実行します。
```
 dotnet run
```
ターミナルからの出力を確認します。項目の一意識別子と操作の要求料金 (RU 単位) がコンソールに出力されているはずです。
dotnet run コマンドを使用して、さらに少なくとも 2 回プロジェクトをビルドして実行します。コンソール出力で RU 料金を確認します。
```
 dotnet run
```
統合ターミナルは開いたままにします。

📝 このターミナルは、この演習で後ほど、再度使用します。元の RU 料金と更新された RU 料金を比較できるよう、ターミナルを開いたままにしておくことが重要です。

インデックス作成ポリシーを更新し、.NET アプリケーションを再実行する

このラボシナリオでは、今後のクエリで name および categoryName プロパティに焦点を当てることを想定します。大きな JSON 項目に最適化するには、すべてのパスを除外して開始するインデックス作成ポリシーを作成して、インデックスから他のすべてのフィールドを除外します。次に、特定のパスを選択してポリシーに含めます。

Web ブラウザーに戻ります。
Azure Cosmos DB アカウントリソース内で、 [データエクスプローラー] ペインに移動します。
[データエクスプローラー] で、cosmicworksデータベースノード、products コンテナーノードの順に展開してから、[設定] を選択します。
[設定] タブで、[インデックス作成ポリシー] セクションに移動します。

既定のインデックス作成ポリシーを確認します。

 {
   "indexingMode": "consistent",
   "automatic": true,
   "includedPaths": [
     {
       "path": "/*"
     }
   ],
   "excludedPaths": [
     {
       "path": "/\"_etag\"/?"
     }
   ]
 }

インデックス作成ポリシーを、次の変更した JSON オブジェクトに置き換え、変更内容を保存します。

 {
   "indexingMode": "consistent",
   "automatic": true,
   "includedPaths": [
     {
       "path": "/name/?"
     },
     {
       "path": "/categoryName/?"
     }
   ],
   "excludedPaths": [
     {
       "path": "/*"
     },
     {
       "path": "/\"_etag\"/?"
     }
   ]
 }

Visual Studio Code に戻ります。開いているターミナルに戻ります。
dotnet run コマンドを使用して、さらに少なくとも 2 回プロジェクトをビルドして実行します。コンソール出力で新しい RU 料金を確認します。元の料金よりかなり低くなっているはずです。すべての項目プロパティにインデックスを作成するわけではないため、インデックスを更新するときの書き込みコストが大幅に低くなります。ただし、インデックスが作成されていないプロパティに対して読み取りでクエリを実行する必要がある場合は、多大なコストがかかる可能性があります。
```
 dotnet run
```
📝更新された RU 料金が表示されない場合は、数分待つ必要があります。
Web ブラウザーに戻ります。

[インデックス作成ポリシー] ページが開かない場合は、[データエクスプローラー] に移動し、cosmicworks データベースノードを展開し、products コンテナーノードで [設定] を選択して、[インデックスポリシー] セクションに移動します。
インデックス作成ポリシーを、次の変更した JSON オブジェクトに置き換え、変更内容を保存します。
```
 {
   "indexingMode": "none"
 }
```
Web ブラウザーのウィンドウまたはタブを閉じます。
Visual Studio Code に戻ります。開いているターミナルに戻ります。
dotnet run コマンドを使用して、さらに少なくとも 2 回プロジェクトをビルドして実行します。コンソール出力で新しい RU 料金を確認します。元の料金よりかなり低くなっているはずです。これはなぜでしょうか。項目を書き込むときに、このスクリプトによって RU が測定されるため、インデックスを持たないことを選ぶと、そのインデックスを保守するオーバーヘッドが生じません。裏を返すと、書き込みで生成される RU は少なくなりますが、読み取りのコストは非常に高くなります。
```
 dotnet run
```
📝更新された RU 料金が表示されない場合は、数分待つ必要があります。
Visual Studio Code を閉じます。