Condividi tramite

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

  • Articolo
  • Si applica a:
    ✅ NoSQL

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-nosql-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 Microsoft.Azure.Cosmos.

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

    cd ./src/web

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

    dotnet add package Microsoft.Azure.Cosmos --version 3.*

  3. Installare anche il pacchetto Azure.Identity se non lo è già.

    dotnet add package Azure.Identity --version 1.12.*

  4. Aprire ed esaminare il file src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj per verificare che le voci Microsoft.Azure.Cosmos e Azure.Identity esistano entrambe.

Modello a oggetti

Nome Descrizione
CosmosClient Questa classe è la classe client primaria e viene usata per gestire i metadati o i database a livello di account.
Database Questa classe rappresenta un database all'interno dell'account.
Container Questa classe viene usata principalmente per eseguire operazioni di lettura, aggiornamento ed eliminazione sul contenitore o sugli elementi archiviati all'interno del contenitore.
PartitionKey Questa classe rappresenta una chiave di partizione logica. Questa classe è necessaria per molte operazioni e query comuni.

Esempi di codice

Il codice di esempio nel modello usa un database denominato cosmicworks e un contenitore denominato products. Il contenitore products contiene dettagli quali nome, categoria, quantità, identificatore univoco e flag di vendita per ogni prodotto. Il contenitore usa la proprietà /category come chiave di partizione logica.

Autenticare il client

Questo esempio crea una nuova istanza della classe CosmosClient ed esegue l'autenticazione usando un'istanza di DefaultAzureCredential.

DefaultAzureCredential credential = new();

CosmosClient client = new(
    accountEndpoint: "<azure-cosmos-db-nosql-account-endpoint>",
    tokenCredential: new DefaultAzureCredential()
);

Ottenere un database

Usare client.GetDatabase per recuperare il database esistente denominato cosmicworks.

Database database = client.GetDatabase("cosmicworks");

Ottenere un contenitore

Recuperare il contenitore products esistente usando database.GetContainer.

Container container = database.GetContainer("products");

Creare un elemento

Creare un tipo di record C# con tutti i membri da serializzare in JSON. In questo esempio il tipo ha un identificatore univoco e i campi per categoria, nome, quantità, prezzo e vendita.

public record Product(
    string id,
    string category,
    string name,
    int quantity,
    decimal price,
    bool clearance
);

Creare un elemento nel contenitore usando container.UpsertItem. Questo metodo esegue l'upsert dell'elemento, in pratica sostituendolo, se esiste già.

Product item = new(
    id: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    category: "gear-surf-surfboards",
    name: "Yamba Surfboard",
    quantity: 12,
    price: 850.00m,
    clearance: false
);

ItemResponse<Product> response = await container.UpsertItemAsync<Product>(
    item: item,
    partitionKey: new PartitionKey("gear-surf-surfboards")
);

Leggere un elemento

Eseguire un'operazione di lettura dei punti usando sia l'identificatore univoco (id) che i campi chiave di partizione. Usare container.ReadItem per recuperare in modo efficiente l'elemento specifico.

ItemResponse<Product> response = await container.ReadItemAsync<Product>(
    id: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partitionKey: new PartitionKey("gear-surf-surfboards")
);

Eseguire query sugli elementi

Eseguire una query su più elementi in un contenitore usando container.GetItemQueryIterator. Trovare tutti gli elementi all'interno di una categoria specificata usando questa query con parametri:

SELECT * FROM products p WHERE p.category = @category

string query = "SELECT * FROM products p WHERE p.category = @category"

var query = new QueryDefinition(query)
  .WithParameter("@category", "gear-surf-surfboards");

using FeedIterator<Product> feed = container.GetItemQueryIterator<Product>(
    queryDefinition: query
);

Analizzare i risultati impaginati della query eseguendo un ciclo in ogni pagina di risultati usando feed.ReadNextAsync. Usare feed.HasMoreResults per determinare se all'inizio di ogni ciclo sono rimasti risultati.

List<Product> items = new();
while (feed.HasMoreResults)
{
    FeedResponse<Product> response = await feed.ReadNextAsync();
    foreach (Product item in response)
    {
        items.Add(item);
    }
}

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