クイック スタート:.NET SDK と Azure Cosmos DB で Table API アプリをビルドする

適用対象: Table API

このクイックスタートでは、GitHub から例を複製することで、.NET と Azure Cosmos DB の Table API を使用してアプリを構築する方法を示します。 このクイックスタートでは、Web ベースの Azure Portal で Azure Cosmos DB アカウントを作成する方法、およびデータ エクスプローラーを使用してテーブルとエンティティを作成する方法も説明します。

前提条件

Visual Studio 2019 をまだインストールしていない場合は、無料Visual Studio 2019 Community エディションをダウンロードして使用できます。 Visual Studio のセットアップ中に、必ず [Azure の開発] を有効にしてください。

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

データベース アカウントの作成

  1. In a new browser window, sign in to the Azure portal.

  2. In the left menu, select Create a resource.

    Create a resource in the Azure portal

  3. On the New page, select Databases > Azure Cosmos DB.

    The Azure portal Databases pane

  4. On the Create Azure Cosmos DB Account page, enter the settings for the new Azure Cosmos DB account.

    Setting Value Description
    Subscription Your subscription Select the Azure subscription that you want to use for this Azure Cosmos DB account.
    Resource Group Create new, then Account Name Select Create new. Then enter a new resource group name for your account. For simplicity, use the same name as your Azure Cosmos DB account name.
    Account Name A unique name Enter a unique name to identify your Azure Cosmos DB account.

    The account name can use only lowercase letters, numbers, and hyphens (-), and must be between 3 and 44 characters long.
    API Table The API determines the type of account to create. Azure Cosmos DB provides five APIs: Core (SQL) for document databases, Gremlin for graph databases, MongoDB for document databases, Azure Table, and Cassandra. You must create a separate account for each API.

    Select Azure Table, because in this quickstart you are creating a table that works with the Table API.

    Learn more about the Table API.
    Location The region closest to your users Select a geographic location to host your Azure Cosmos DB account. Use the location that's closest to your users to give them the fastest access to the data.
    Capacity mode Provisioned throughput or Serverless Select Provisioned throughput to create an account in provisioned throughput mode. Select Serverless to create an account in serverless mode.

    You can leave the Geo-Redundancy and Multi-region Writes options at Disable to avoid additional charges, and skip the Network and Tags sections.

  5. Select Review+Create. After the validation is complete, select Create to create the account.

    The new account page for Azure Cosmos DB

  6. It takes a few minutes to create the account. You'll see a message that states Your deployment is underway. Wait for the deployment to finish, and then select Go to resource.

    The Azure portal notifications pane

テーブルの追加

You can now use the Data Explorer tool in the Azure portal to create a database and table.

  1. Select Data Explorer > New Table.

    The Add Table area is displayed on the far right, you may need to scroll right to see it.

    Data Explorer in the Azure portal

  2. In the Add Table page, enter the settings for the new table.

    Setting Suggested value Description
    Table Id sample-table The ID for your new table. Table names have the same character requirements as database ids. Database names must be between 1 and 255 characters, and cannot contain / \ # ? or a trailing space.
    Throughput 400 RUs Change the throughput to 400 request units per second (RU/s). If you want to reduce latency, you can scale up the throughput later.
  3. Select OK.

  4. Data Explorer displays the new database and table.

    The Azure portal Data Explorer, showing the new database and collection

サンプル データの追加

You can now add data to your new table using Data Explorer.

  1. In Data Explorer, expand sample-table, select Entities, and then select Add Entity.

    Create new entities in Data Explorer in the Azure portal

  2. Now add data to the PartitionKey value box and RowKey value box, and select Add Entity.

    Set the Partition Key and Row Key for a new entity

    You can now add more entities to your table, edit your entities, or query your data in Data Explorer. Data Explorer is also where you can scale your throughput and add stored procedures, user-defined functions, and triggers to your table.

サンプル アプリケーションの複製

GitHub で Table アプリの複製を作成し、接続文字列を設定して実行します。 プログラムでデータを処理することが非常に簡単であることがわかります。

  1. コマンド プロンプトを開いて git-samples という名前の新しいフォルダーを作成し、コマンド プロンプトを閉じます。

    md "C:\git-samples"
    
  2. git bash などの git ターミナル ウィンドウを開いて、cd コマンドを使用して、サンプル アプリをインストールする新しいフォルダーに変更します。

    cd "C:\git-samples"
    
  3. 次のコマンドを実行して、サンプル レポジトリを複製します。 このコマンドは、コンピューター上にサンプル アプリのコピーを作成します。

    git clone https://github.com/Azure-Samples/azure-cosmos-table-dotnet-core-getting-started.git
    

ヒント

類似のコードの詳細なチュートリアルについては、Cosmos DB Table API サンプルに関する記事を参照してください。

Visual Studio でサンプル アプリケーションを開く

  1. Visual Studio で、 [ファイル] メニューから [開く] を選択して、 [プロジェクト/ソリューション] を選択します。

    ソリューションを開く

  2. サンプル アプリケーションを複製したフォルダーに移動し、TableStorage.sln ファイルを開きます。

コードの確認

この手順は省略可能です。 コード内のデータベース リソースの作成方法に関心がある場合は、次のスニペットを確認できます。 関心がない場合は、このドキュメントの「接続文字列を更新する」セクションに進んでください。

  • 次のコードは、Azure Storage 内にテーブルを作成する方法を示しています。

    public static async Task<CloudTable> CreateTableAsync(string tableName)
    {
        string storageConnectionString = AppSettings.LoadAppSettings().StorageConnectionString;
    
        // Retrieve storage account information from connection string.
        CloudStorageAccount storageAccount = CreateStorageAccountFromConnectionString(storageConnectionString);
    
        // Create a table client for interacting with the table service
        CloudTableClient tableClient = storageAccount.CreateCloudTableClient(new TableClientConfiguration());
    
        Console.WriteLine("Create a Table for the demo");
    
        // Create a table client for interacting with the table service 
        CloudTable table = tableClient.GetTableReference(tableName);
        if (await table.CreateIfNotExistsAsync())
        {
            Console.WriteLine("Created Table named: {0}", tableName);
        }
        else
        {
            Console.WriteLine("Table {0} already exists", tableName);
        }
    
        Console.WriteLine();
        return table;
    }
    
  • 次のコードは、テーブルにデータを挿入する方法を示しています。

    public static async Task<CustomerEntity> InsertOrMergeEntityAsync(CloudTable table, CustomerEntity entity)
    {
        if (entity == null)
        {
            throw new ArgumentNullException("entity");
        }
    
        try
        {
            // Create the InsertOrReplace table operation
            TableOperation insertOrMergeOperation = TableOperation.InsertOrMerge(entity);
    
            // Execute the operation.
            TableResult result = await table.ExecuteAsync(insertOrMergeOperation);
            CustomerEntity insertedCustomer = result.Result as CustomerEntity;
    
            if (result.RequestCharge.HasValue)
            {
                Console.WriteLine("Request Charge of InsertOrMerge Operation: " + result.RequestCharge);
            }
    
            return insertedCustomer;
        }
        catch (StorageException e)
        {
            Console.WriteLine(e.Message);
            Console.ReadLine();
            throw;
        }
    }
    
  • 次のコードは、テーブルにデータを照会する方法を示しています。

    public static async Task<CustomerEntity> RetrieveEntityUsingPointQueryAsync(CloudTable table, string partitionKey, string rowKey)
    {
        try
        {
            TableOperation retrieveOperation = TableOperation.Retrieve<CustomerEntity>(partitionKey, rowKey);
            TableResult result = await table.ExecuteAsync(retrieveOperation);
            CustomerEntity customer = result.Result as CustomerEntity;
            if (customer != null)
            {
                Console.WriteLine("\t{0}\t{1}\t{2}\t{3}", customer.PartitionKey, customer.RowKey, customer.Email, customer.PhoneNumber);
            }
    
            if (result.RequestCharge.HasValue)
            {
                Console.WriteLine("Request Charge of Retrieve Operation: " + result.RequestCharge);
            }
    
            return customer;
        }
        catch (StorageException e)
        {
            Console.WriteLine(e.Message);
            Console.ReadLine();
            throw;
        }
    }
    
  • 次のコードは、テーブルのデータを削除する方法を示しています。

    public static async Task DeleteEntityAsync(CloudTable table, CustomerEntity deleteEntity)
    {
        try
        {
            if (deleteEntity == null)
            {
                throw new ArgumentNullException("deleteEntity");
            }
    
            TableOperation deleteOperation = TableOperation.Delete(deleteEntity);
            TableResult result = await table.ExecuteAsync(deleteOperation);
    
            if (result.RequestCharge.HasValue)
            {
                Console.WriteLine("Request Charge of Delete Operation: " + result.RequestCharge);
            }
    
        }
        catch (StorageException e)
        {
            Console.WriteLine(e.Message);
            Console.ReadLine();
            throw;
        }
    }
    

接続文字列を更新する

ここで Azure Portal に戻り、接続文字列情報を取得し、アプリにコピーします。 これでアプリが、ホストされているデータベースと通信できます。

  1. Azure Portal[接続文字列] をクリックします。 ウィンドウの右側にある [コピー] ボタンを使って プライマリ接続文字列 をコピーします。

    [接続文字列] ウィンドウでプライマリ接続文字列を確認してコピーする

  2. Visual Studio で Settings.json ファイルを開きます。

  3. ポータルの プライマリ接続文字列 を StorageConnectionString に貼り付けます。 引用符の内側に文字列を貼り付けます。

    {
       "StorageConnectionString": "<Primary connection string from Azure portal>"
    }
    
  4. CTRL キーを押しながら S キーを押して Settings.json ファイルを保存します。

これで、Azure Cosmos DB と通信するために必要なすべての情報でアプリを更新しました。

アプリを構築してデプロイする

  1. Visual Studio の ソリューション エクスプローラーCosmosTableSamples プロジェクトを右クリックし、 [NuGet パッケージの管理] をクリックします。

    NuGet パッケージの管理

  2. NuGet の [参照] ボックスに「Microsoft.Azure.Cosmos.Table」と入力します。 これで、Cosmos DB テーブル API のクライアント ライブラリが見つかります。 このライブラリは、現在 .NET Framework と .NET Standard で使用できることにご留意ください。

    NuGet の [参照] タブ

  3. [インストール] をクリックして Microsoft.Azure.Cosmos.Table ライブラリをインストールします。 これにより、Azure Cosmos DB Table API パッケージとすべての依存関係がインストールされます。

  4. アプリ全体を実行すると、サンプル データがテーブル エンティティに挿入され、終わりのところで削除されます。そのため、サンプル全体を実行した場合、データが挿入されても表示されません。 ただし、ブレークポイントを挿入することでデータを表示できます。 BasicSamples.cs ファイルを開き、52 行目を右クリックし、 [ブレークポイント][ブレークポイントの挿入] を順に選択します。 55 行目にもブレークポイントを挿入します。

    ブレークポイントの追加

  5. F5 キーを押してアプリケーションを実行します。 コンソール ウィンドウに、Azure Cosmos DB の新しいテーブル データベースの名前 (この場合は demoa13b1) が表示されます。

    コンソール出力

    最初のブレークポイントにヒットしたら、Azure Portal のデータ エクスプローラーに戻ります。 [最新の情報に更新] ボタンをクリックし、demo* table を展開して [エンティティ] をクリックします。 右側の [エンティティ] タブに、追加された Walter Harp の新しいエンティティが表示されます。 新しいエンティティの電話番号が 425-555-0101 であることを確認します。

    新しいエンティティ

    プロジェクトを実行するときに Settings.json ファイルが見つからないというエラーが発生した場合は、次の XML エントリをプロジェクトの設定に追加することで解決できます。 CosmosTableSamples を右クリックし、[CosmosTableSamples.csproj の編集] を選択して、次の itemGroup を追加します。

      <ItemGroup>
        <None Update="Settings.json">
          <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
      </ItemGroup>
    
  6. データ エクスプローラーの [エンティティ] タブを閉じます。

  7. F5 キーを押して、次のブレークポイントまでアプリを実行します。

    ブレークポイントにヒットしたら、Azure Portal に戻り、 [エンティティ] を再びクリックして [エンティティ] タブを開き、電話番号が 425-555-0105 に更新されていることを確認します。

  8. F5 キーを押して、アプリを実行します。

    アプリによって高度なサンプル アプリで使用するためのエンティティが追加されますが、これらはテーブル API では現在サポートされていません。 その後、アプリは、サンプル アプリによって作成されたテーブルを削除します。

  9. コンソール ウィンドウで Enter キーを押してアプリの実行を終了します。

Azure Portal での SLA の確認

The Azure portal monitors your Cosmos DB account throughput, storage, availability, latency, and consistency. Charts for metrics associated with an Azure Cosmos DB Service Level Agreement (SLA) show the SLA value compared to actual performance. This suite of metrics makes monitoring your SLAs transparent.

To review metrics and SLAs:

  1. Select Metrics in your Cosmos DB account's navigation menu.

  2. Select a tab such as Latency, and select a timeframe on the right. Compare the Actual and SLA lines on the charts.

    Azure Cosmos DB metrics suite

  3. Review the metrics on the other tabs.

リソースをクリーンアップする

When you're done with your app and Azure Cosmos DB account, you can delete the Azure resources you created so you don't incur more charges. To delete the resources:

  1. In the Azure portal Search bar, search for and select Resource groups.

  2. From the list, select the resource group you created for this quickstart.

    Select the resource group to delete

  3. On the resource group Overview page, select Delete resource group.

    Delete the resource group

  4. In the next window, enter the name of the resource group to delete, and then select Delete.

次のステップ

このクイック スタートでは、Azure Cosmos DB アカウントを作成し、データ エクスプローラーを使用してテーブルを作成し、アプリを実行する方法を説明しました。 これで、Table API を使用して、データをクエリできます。