Delen via

Quickstart: Azure Cosmos DB for NoSQL gebruiken met Azure SDK voor .NET

  • Artikel
  • Van toepassing op:
    ✅ NoSQL

In deze quickstart implementeert u een eenvoudige Azure Cosmos DB for Table-toepassing met behulp van de Azure SDK voor .NET. Azure Cosmos DB for Table is een schemaloos gegevensarchief waarmee toepassingen gestructureerde tabelgegevens in de cloud kunnen opslaan. U leert hoe u tabellen, rijen maakt en basistaken uitvoert in uw Azure Cosmos DB-resource met behulp van de Azure SDK voor .NET.

Api-referentiedocumentatiebibliotheek | broncodepakket | (NuGet) | Azure Developer CLI

Vereisten

  • Azure Developer CLI
  • Docker Desktop
  • .NET 9.0

Als u geen Azure-account hebt, maak dan een gratis account aan voordat u begint.

Het project initialiseren

Gebruik de Azure Developer CLI (azd) om een Azure Cosmos DB for Table-account te maken en een in een container geplaatste voorbeeldtoepassing te implementeren. De voorbeeldtoepassing maakt gebruik van de clientbibliotheek voor het beheren, maken, lezen en opvragen van voorbeeldgegevens.

  1. Open een terminal in een lege map.

  2. Als u nog niet bent geverifieerd, moet u zich verifiëren bij de Azure Developer CLI met behulp van azd auth login. Volg de stappen die door het hulpprogramma zijn opgegeven om te verifiëren bij de CLI met behulp van uw favoriete Azure-referenties.

    azd auth login

  3. Gebruik azd init dit om het project te initialiseren.

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

  4. Configureer tijdens de initialisatie een unieke omgevingsnaam.

  5. Implementeer het Azure Cosmos DB-account met behulp van azd up. De Bicep-sjablonen implementeren ook een voorbeeldwebtoepassing.

    azd up

  6. Selecteer tijdens het inrichtingsproces uw abonnement, gewenste locatie en doelresourcegroep. Wacht tot het inrichtingsproces is voltooid. Het proces kan ongeveer vijf minuten duren.

  7. Zodra het inrichten van uw Azure-resources is voltooid, wordt er een URL naar de actieve webtoepassing opgenomen in de uitvoer.

    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. Gebruik de URL in de console om naar uw webtoepassing in de browser te navigeren. Bekijk de uitvoer van de actieve app.

Schermopname van de actieve webtoepassing.

De clientbibliotheek installeren

De clientbibliotheek is beschikbaar via NuGet, als pakket Microsoft.Azure.Cosmos .

  1. Open een terminal en navigeer naar de /src/web map.

    cd ./src/web

  2. Als dit nog niet is geïnstalleerd, installeert u het Microsoft.Azure.Cosmos pakket met behulp van dotnet add package.

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

  3. Installeer ook het Azure.Identity pakket als dat nog niet is geïnstalleerd.

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

  4. Open en controleer het bestand src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj om te valideren dat de Microsoft.Azure.Cosmos en Azure.Identity beide vermeldingen bestaan.

Objectmodel

Name Beschrijving
CosmosClient Deze klasse is de primaire clientklasse en wordt gebruikt voor het beheren van metagegevens of databases voor het hele account.
Database Deze klasse vertegenwoordigt een database binnen het account.
Container Deze klasse wordt voornamelijk gebruikt om lees-, update- en verwijderbewerkingen uit te voeren op de container of de items die zijn opgeslagen in de container.
PartitionKey Deze klasse vertegenwoordigt een logische partitiesleutel. Deze klasse is vereist voor veel algemene bewerkingen en query's.

Codevoorbeelden

De voorbeeldcode in de sjabloon maakt gebruik van een database met de naam cosmicworks en container.products De products container bevat details zoals naam, categorie, hoeveelheid, een unieke id en een verkoopvlag voor elk product. De container gebruikt de /category eigenschap als een logische partitiesleutel.

De client verifiëren

In dit voorbeeld wordt een nieuw exemplaar van de CosmosClient klasse gemaakt en wordt geverifieerd met behulp van een DefaultAzureCredential exemplaar.

DefaultAzureCredential credential = new();

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

Een database ophalen

Gebruik client.GetDatabase deze om de bestaande database met de naam cosmicworksop te halen.

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

Een container ophalen

Haal de bestaande products container op met behulp van database.GetContainer.

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

Een item maken

Bouw een C#-recordtype met alle leden die u in JSON wilt serialiseren. In dit voorbeeld heeft het type een unieke id en velden voor categorie, naam, hoeveelheid, prijs en verkoop.

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

Maak een item in de container met behulp van container.UpsertItem. Met deze methode wordt het item effectief vervangen als het al bestaat.

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")
);

Een item lezen

Voer een puntleesbewerking uit met behulp van zowel de unieke id (id) als de partitiesleutelvelden. Gebruik container.ReadItem dit om het specifieke item efficiënt op te halen.

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

Query-items

Voer een query uit op meerdere items in een container met behulp van container.GetItemQueryIterator. Zoek alle items in een opgegeven categorie met behulp van deze geparameteriseerde query:

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

Parseer de gepagineerde resultaten van de query door elke pagina met resultaten te doorlopen met behulp feed.ReadNextAsyncvan . Gebruik feed.HasMoreResults dit om te bepalen of er resultaten achterblijven aan het begin van elke lus.

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

Resources opschonen

Wanneer u de voorbeeldtoepassing of resources niet meer nodig hebt, verwijdert u de bijbehorende implementatie en alle resources.

azd down

Gerelateerde inhoud