Condividi tramite

Guida introduttiva: Usare Azure Cosmos DB per tabelle con Azure SDK per .NET

  • Articolo
  • Si applica a:
    ✅ Table

In questa guida introduttiva si distribuisce un'applicazione Azure Cosmos DB per tabelle di base usando Azure SDK per .NET. Azure Cosmos DB per tabella è un archivio dati senza schema che consente alle applicazioni di archiviare dati strutturati della tabella nel cloud. Si apprenderà come creare tabelle, righe ed eseguire attività di base all'interno della risorsa di Azure Cosmos DB usando Azure SDK per .NET.

Documentazione di riferimento dell'API | Codice sorgente della libreria | Pacchetto (NuGet) | Azure Developer CLI

Prerequisiti

  • Azure Developer CLI
  • Docker Desktop
  • .NET 9.0

Se non si ha un account Azure, creare un account gratuito prima di iniziare.

Inizializzare il progetto

Usare l'interfaccia della riga di comando per sviluppatori di Azure (azd) per creare un account Azure Cosmos DB per tabelle e distribuire un'applicazione di esempio in contenitori. L'applicazione di esempio usa la libreria client per gestire, creare, leggere ed eseguire query sui dati di esempio.

  1. Aprire un terminale in una directory vuota.

  2. Se non si è già autenticati, eseguire l'autenticazione all'interfaccia della riga di comando per sviluppatori di Azure usando azd auth login. Seguire i passaggi specificati dallo strumento per eseguire l'autenticazione all'interfaccia della riga di comando usando le credenziali di Azure preferite.

    azd auth login

  3. Usare azd init per inizializzare il progetto.

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

  4. Durante l'inizializzazione, configurare un nome di ambiente univoco.

  5. Distribuire l'account Azure Cosmos DB usando azd up. I modelli Bicep distribuiscono anche un'applicazione Web di esempio.

    azd up

  6. Durante il processo di provisioning selezionare la sottoscrizione, la località desiderata e il gruppo di risorse di destinazione. Attendere il completamento del processo di provisioning. Per il processo sono necessari circa 5 minuti.

  7. Al termine del provisioning delle risorse di Azure, nell'output viene incluso un URL dell'applicazione Web in esecuzione.

    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. Usare l'URL nella console per passare all'applicazione Web nel browser. Osservare l'output dell'app in esecuzione.

Screenshot dell'applicazione Web in esecuzione.

Installare la libreria client

La libreria client è disponibile tramite NuGet, come pacchetto Azure.Data.Tables.

  1. Aprire un terminale e passare alla cartella /src/web:

    cd ./src/web

  2. Se non è già installato, installare il pacchetto Azure.Data.Tables usando dotnet add package.

    dotnet add package Azure.Data.Tables

  3. Aprire ed esaminare il file src/web/Microsoft.Samples.Cosmos.Table.Quickstart.Web.csproj per verificare che la Azure.Data.Tables voce esista.

Modello a oggetti

Nome Descrizione
TableServiceClient Questa classe è la classe client primaria e viene usata per gestire i metadati o i database a livello di account.
TableClient Questa classe rappresenta il client per una tabella all'interno dell'account.

Esempi di codice

Il codice di esempio nel modello usa una tabella denominata cosmicworks-products. La cosmicworks-products tabella contiene dettagli quali nome, categoria, quantità, prezzo, identificatore univoco e flag di vendita per ogni prodotto. Il contenitore usa un identificatore univoco come chiave di riga e categoria come chiave di partizione.

Autenticare il client

In questo esempio viene creata una nuova istanza della TableServiceClient classe .

DefaultAzureCredential credential = new();

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

Ottenere una tabella

In questo esempio viene creata un'istanza della TableClient classe usando il GetTableClient metodo della TableServiceClient classe .

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

Creare un'entità

Il modo più semplice per creare una nuova entità in una tabella consiste nel creare una classe che implementa l'interfaccia ITableEntity . È quindi possibile aggiungere proprietà personalizzate alla classe per popolare le colonne di dati in quella riga della tabella.

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

Creare un'entità nella tabella usando la Product classe chiamando 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
);

Ottenere un'entità

È possibile recuperare un'entità specifica da una tabella usando il TableClient.GetEntityAsync<T> metodo . Specificare e partitionKey rowKey come parametri per identificare la riga corretta per eseguire una lettura rapida di tale entità.

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

Eseguire query sulle entità

Dopo aver inserito un'entità, è anche possibile eseguire una query per ottenere tutte le entità che corrispondono a un filtro specifico usando il TableClient.Query<T> metodo . In questo esempio vengono filtrati i prodotti per categoria usando la sintassi LINQ (Language Integrated Query), che è un vantaggio dell'uso di modelli tipizzati ITableEntity come la Product classe .

string category = "gear-surf-surfboards";

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

Analizzare i risultati impaginati della query eseguendo un ciclo in ogni pagina di risultati usando un ciclo asincrono.

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

Pulire le risorse

Quando l'applicazione o le risorse di esempio non sono più necessarie, rimuovere la distribuzione corrispondente e tutte le risorse.

azd down

Contenuto correlato