Szybki start: używanie usługi Azure Cosmos DB dla tabel z zestawem Azure SDK dla platformy .NET

  • Dotyczy: ✅ Table

Ważna

Szukasz rozwiązania bazy danych dla scenariuszy o dużej skali z umową SLA gwarantującą poziom dostępności na poziomie 99,999%, natychmiastowym skalowaniem automatycznym i automatycznym przełączaniem awaryjnym między wieloma regionami? Rozważmy usługę Azure Cosmos DB dla noSQL.

W tym szybkim przewodniku wdrażasz podstawową aplikację tabeli Azure Cosmos DB przy użyciu zestawu Azure SDK dla platformy .NET. Usługa Azure Cosmos DB dla tabel to magazyn danych bez schematu, który umożliwia aplikacjom przechowywanie uporządkowanych danych tabelarycznych w chmurze. Dowiesz się, jak tworzyć tabele, wiersze i wykonywać podstawowe zadania w ramach zasobu usługi Azure Cosmos DB przy użyciu zestawu Azure SDK dla platformy .NET.

Dokumentacja referencyjna interfejsu API | Kod źródłowy biblioteki | Pakiet (NuGet) | Azure Developer CLI

Prerequisites

  • Azure Developer CLI
  • Docker Desktop
  • .NET 9.0

Jeśli nie masz jeszcze konta platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Inicjowanie projektu

Użyj interfejsu wiersza polecenia dla deweloperów platformy Azure (azd), aby utworzyć usługę Azure Cosmos DB dla konta tabeli i wdrożyć konteneryzowaną przykładową aplikację. Przykładowa aplikacja używa biblioteki klienta do zarządzania, tworzenia, odczytywania i wykonywania zapytań dotyczących przykładowych danych.

  1. Otwórz terminal w pustym katalogu.

  2. Jeśli jeszcze nie jesteś uwierzytelniony, uwierzytelnij się za pomocą Azure Developer CLI przy użyciu polecenia azd auth login. Wykonaj kroki określone przez narzędzie, aby uwierzytelnić się w interfejsie wiersza polecenia przy użyciu preferowanych poświadczeń platformy Azure.

    azd auth login

  3. Użyj azd init do zainicjowania projektu.

    azd init --template cosmos-db-table-dotnet-quickstart

  4. Podczas inicjowania skonfiguruj unikatową nazwę środowiska.

  5. Wdróż konto usługi Azure Cosmos DB przy użyciu polecenia azd up. Szablony Bicep wdrażają również przykładową aplikację internetową.

    azd up

  6. Podczas procesu aprowizacji wybierz subskrypcję, żądaną lokalizację i docelową grupę zasobów. Poczekaj na zakończenie procesu konfiguracji. Proces może potrwać około pięciu minut.

  7. Po zakończeniu aprowizacji zasobów platformy Azure adres URL uruchomionej aplikacji internetowej zostanie uwzględniony w danych wyjściowych.

    Deploying services (azd deploy)

  (✓) Done: Deploying service web
- Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>

SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.

  8. Użyj adresu URL w konsoli, aby przejść do aplikacji internetowej w przeglądarce. Obserwuj dane wyjściowe uruchomionej aplikacji.

Zrzut ekranu przedstawiający uruchomioną aplikację internetową.

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna jako pakiet Azure.Data.Tables za pośrednictwem NuGet.

  1. Otwórz terminal i przejdź do /src/web folderu.

    cd ./src/web

  2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj Azure.Data.Tables przy użyciu polecenia dotnet add package.

    dotnet add package Azure.Data.Tables

  3. Otwórz i przejrzyj plik src/web/Microsoft.Samples.Cosmos.Table.Quickstart.Web.csproj, aby zweryfikować, czy wpis Azure.Data.Tables istnieje.

Importowanie bibliotek

Zaimportuj przestrzenie nazw Azure.Identity i Azure.Data.Tables do swojego kodu aplikacji.

using Azure.Identity;

using Azure.Data.Tables;

Model obiektów

Name Description
TableServiceClient Ta klasa jest podstawową klasą klienta i służy do zarządzania metadanymi lub bazami danych dla całego konta.
TableClient Ta klasa reprezentuje klienta do pracy z tabelą w ramach konta.

Przykłady kodu

Przykładowy kod w szablonie używa tabeli o nazwie cosmicworks-products. Tabela cosmicworks-products zawiera szczegółowe informacje, takie jak nazwa, kategoria, ilość, cena, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Kontener używa unikatowego identyfikatora jako klucza wiersza i kategorii jako klucza partycji.

Uwierzytelnianie klienta

Ten przykład tworzy nowe wystąpienie TableServiceClient klasy.

DefaultAzureCredential credential = new();

TableServiceClient serviceClient = new(
    endpoint: new Uri("<azure-cosmos-db-table-account-endpoint>"),
    credential
);

Zdobądź stolik

Ten przykład tworzy instancję klasy TableClient za pomocą metody GetTableClient klasy TableServiceClient.

TableClient client = serviceClient.GetTableClient(
    tableName: "<azure-cosmos-db-table-name>"
);

Tworzenie jednostki

Najprostszym sposobem utworzenia nowej jednostki w tabeli jest utworzenie klasy implementujące ITableEntity interfejs. Następnie możesz dodać własne właściwości do klasy, aby wypełnić kolumny danych w tym wierszu tabeli.

public record Product : ITableEntity
{
    public required string RowKey { get; set; }

    public required string PartitionKey { get; set; }

    public required string Name { get; set; }

    public required int Quantity { get; set; }

    public required decimal Price { get; set; }

    public required bool Clearance { get; set; }

    public ETag ETag { get; set; } = ETag.All;

    public DateTimeOffset? Timestamp { get; set; }
};

Utwórz jednostkę w tabeli, używając klasy Product, wywołując TableClient.AddEntityAsync<T>.

Product entity = new()
{
    RowKey = "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    PartitionKey = "gear-surf-surfboards",
    Name = "Surfboard",
    Quantity = 10,
    Price = 300.00m,
    Clearance = true
};

Response response = await client.UpsertEntityAsync<Product>(
    entity: entity,
    mode: TableUpdateMode.Replace
);

Pobierz jednostkę

Określoną jednostkę można pobrać z tabeli przy użyciu TableClient.GetEntityAsync<T> metody . partitionKey oraz rowKey podaj jako parametry, aby zidentyfikować prawidłowy wiersz do szybkiego odczytu tego punktu.

Response<Product> response = await client.GetEntityAsync<Product>(
    rowKey: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partitionKey: "gear-surf-surfboards"
);

Wykonywanie zapytań o jednostki

Po wstawieniu jednostki można również uruchomić zapytanie, aby pobrać wszystkie jednostki zgodne z określonym filtrem TableClient.Query<T> przy użyciu metody . W tym przykładzie produkty są filtrowane według kategorii z użyciem składni języka zintegrowanego LINQ, co stanowi zaletę używania modeli typizowanych, takich jak klasa ITableEntity.

string category = "gear-surf-surfboards";

AsyncPageable<Product> results = client.QueryAsync<Product>(
    product => product.PartitionKey == category
);

Przeanalizuj wyniki zapytania podzielonego na strony, przechodząc przez każdą stronę wyników przy użyciu asynchronicznego loopu.

List<Product> entities = new();
await foreach (Product product in results)
{
    entities.Add(product);
}

Uprzątnij zasoby

Jeśli nie potrzebujesz już przykładowej aplikacji lub zasobów, usuń odpowiednie wdrożenie i wszystkie zasoby.

azd down

Treści powiązane

  • Last updated on