Dela via

Snabbstart: Använda Azure Cosmos DB for Table med Azure SDK för .NET

  • Artikel
  • Gäller för:
    ✅ Table

I den här snabbstarten distribuerar du ett grundläggande Azure Cosmos DB for Table-program med hjälp av Azure SDK för .NET. Azure Cosmos DB for Table är ett schemalöst datalager som gör att program kan lagra strukturerade tabelldata i molnet. Du lär dig hur du skapar tabeller, rader och utför grundläggande uppgifter i din Azure Cosmos DB-resurs med hjälp av Azure SDK för .NET.

API-referensdokumentation Bibliotek källkodspaket | (NuGet) | Azure Developer CLI |

Förutsättningar

  • Azure Developer CLI
  • Docker Desktop
  • .NET 9.0

Om du inte har något Azure-konto skapar du ett kostnadsfritt konto innan du börjar.

Initiera projektet

Använd Azure Developer CLI (azd) för att skapa ett Azure Cosmos DB för tabellkonto och distribuera ett containerbaserat exempelprogram. Exempelprogrammet använder klientbiblioteket för att hantera, skapa, läsa och fråga efter exempeldata.

  1. Öppna en terminal i en tom katalog.

  2. Om du inte redan är autentiserad autentiserar du till Azure Developer CLI med .azd auth login Följ stegen som anges av verktyget för att autentisera till CLI med dina önskade Azure-autentiseringsuppgifter.

    azd auth login

  3. Använd azd init för att initiera projektet.

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

  4. Under initieringen konfigurerar du ett unikt miljönamn.

  5. Distribuera Azure Cosmos DB-kontot med .azd up Bicep-mallarna distribuerar också ett exempelwebbprogram.

    azd up

  6. Under etableringsprocessen väljer du din prenumeration, önskad plats och målresursgrupp. Vänta tills etableringsprocessen har slutförts. Processen kan ta ungefär fem minuter.

  7. När etableringen av dina Azure-resurser är klar inkluderas en URL till det webbprogram som körs i utdata.

    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. Använd URL:en i konsolen för att navigera till webbprogrammet i webbläsaren. Observera utdata från appen som körs.

Skärmbild av webbprogrammet som körs.

Installera klientbiblioteket

Klientbiblioteket är tillgängligt via NuGet som Azure.Data.Tables paket.

  1. Öppna en terminal och navigera till /src/web mappen.

    cd ./src/web

  2. Om det inte redan är installerat installerar du Azure.Data.Tables paketet med .dotnet add package

    dotnet add package Azure.Data.Tables

  3. Öppna och granska filen src/web/Microsoft.Samples.Cosmos.Table.Quickstart.Web.csproj för att verifiera att posten Azure.Data.Tables finns.

Objektmodell

Name beskrivning
TableServiceClient Den här klassen är den primära klientklassen och används för att hantera kontoomfattande metadata eller databaser.
TableClient Den här klassen representerar klienten för en tabell i kontot.

Kodexempel

Exempelkoden i mallen använder en tabell med namnet cosmicworks-products. Tabellen cosmicworks-products innehåller information som namn, kategori, kvantitet, pris, en unik identifierare och en försäljningsflagga för varje produkt. Containern använder en unik identifierare som radnyckel och kategori som partitionsnyckel.

Autentisera klienten

Det här exemplet skapar en ny instans av TableServiceClient klassen.

DefaultAzureCredential credential = new();

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

Hämta en tabell

Det här exemplet skapar en instans av TableClient klassen med GetTableClient hjälp av -metoden för TableServiceClient klassen.

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

Skapa en entitet

Det enklaste sättet att skapa en ny entitet i en tabell är att skapa en klass som implementerar ITableEntity gränssnittet. Du kan sedan lägga till dina egna egenskaper i klassen för att fylla i kolumner med data i den tabellraden.

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; }
};

Skapa en entitet i tabellen med hjälp Product av klassen genom att anropa 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
);

Hämta en entitet

Du kan hämta en specifik entitet från en tabell med hjälp av TableClient.GetEntityAsync<T> metoden . Ange parametrarna partitionKey och rowKey för att identifiera rätt rad för att utföra en snabbpunktsläsning av den entiteten.

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

Fråga entiteter

När du har infogat en entitet kan du också köra en fråga för att hämta alla entiteter som matchar ett visst filter med hjälp TableClient.Query<T> av metoden. I det här exemplet filtreras produkter efter kategori med hjälp av LINQ-syntax (Language Integrated Query), vilket är en fördel med att använda inskrivna ITableEntity modeller som Product klassen.

string category = "gear-surf-surfboards";

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

Parsa de sidnumrerade resultaten av frågan genom att loopa igenom varje sida med resultat med hjälp av en asynkron loop.

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

Rensa resurser

När du inte längre behöver exempelprogrammet eller resurserna tar du bort motsvarande distribution och alla resurser.

azd down

Relaterat innehåll