Sdílet prostřednictvím


Rychlý start: Použití služby Azure Cosmos DB for NoSQL se sadou Azure SDK for Go

V tomto rychlém startu nasadíte základní aplikaci Azure Cosmos DB for NoSQL pomocí sady Azure SDK for Go. Azure Cosmos DB for NoSQL je úložiště dat bez schématu, které umožňuje aplikacím ukládat nestrukturovaná data v cloudu. Dotazování dat v kontejnerech a provádění běžných operací s jednotlivými položkami pomocí sady Azure SDK for Go

Referenční dokumentace k rozhraní API | Zdrojový kód knihovny | Balíček (Go) | Azure Developer CLI

Požadavky

  • Azure Developer CLI
  • Docker Desktop
  • Go 1.21 nebo novější

Pokud nemáte účet Azure, vytvořte si bezplatný účet před tím, než začnete.

Inicializace projektu

Pomocí Azure Developer CLI (azd) vytvořte účet Azure Cosmos DB for NoSQL a nasaďte kontejnerizovanou ukázkovou aplikaci. Ukázková aplikace používá klientskou knihovnu ke správě, vytváření, čtení a dotazování ukázkových dat.

  1. Otevřete terminál v prázdném adresáři.

  2. Pokud ještě nejste ověřeni, ověřte se v Azure Developer CLI pomocí azd auth login. Postupujte podle kroků určených nástrojem k ověření v rozhraní příkazového řádku pomocí vašich upřednostňovaných přihlašovacích údajů Azure.

    azd auth login
    
  3. Slouží azd init k inicializaci projektu.

    azd init --template cosmos-db-nosql-go-quickstart
    
  4. Během inicializace nakonfigurujte jedinečný název prostředí.

  5. Nasaďte účet služby Azure Cosmos DB pomocí azd up. Šablony Bicep také nasazují ukázkovou webovou aplikaci.

    azd up
    
  6. Během procesu zřizování vyberte vaše předplatné, požadované umístění a cílovou skupinu zdrojů. Počkejte na dokončení procesu zřizování. Proces může trvat přibližně pět minut.

  7. Po dokončení zřizování prostředků Azure se do výstupu zahrne adresa URL spuštěné webové aplikace.

    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. Pomocí adresy URL v konzole přejděte do webové aplikace v prohlížeči. Sledujte výstup spuštěné aplikace.

Snímek obrazovky se spuštěnou webovou aplikací

Instalace klientské knihovny

Klientská knihovna je k dispozici prostřednictvím jazyka azcosmos Go jako balíček.

  1. Otevřete terminál a přejděte do /src složky.

    cd ./src
    
  2. Pokud ještě není nainstalovaný, nainstalujte azcosmos balíček pomocí go install.

    go install github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
    
  3. Pokud ještě není nainstalovaný, nainstalujte azidentity balíček.

    go install github.com/Azure/azure-sdk-for-go/sdk/azidentity
    
  4. Otevřete a zkontrolujte soubor src/go.mod a ověřte, že github.com/Azure/azure-sdk-for-go/sdk/data/azcosmosgithub.com/Azure/azure-sdk-for-go/sdk/azidentity obě položky existují.

Import knihoven

Importujte balíčky github.com/Azure/azure-sdk-for-go/sdk/azidentity a github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos do kódu vaší aplikace.

import (
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos"
)

Objektový model

Název Popis
CosmosClient Tato třída je primární klientskou třídou a slouží ke správě metadat nebo databází pro celý účet.
CosmosDatabase Tato třída představuje databázi v rámci účtu.
CosmosContainer Tato třída se primárně používá k provádění operací čtení, aktualizace a odstraňování v kontejneru nebo v položkách uložených v kontejneru.
PartitionKey Tato třída představuje klíč pro logický oddíl. Tato třída se vyžaduje pro mnoho běžných operací a dotazů.

Příklady kódu

Vzorový kód v šabloně používá databázi pojmenovanou cosmicworks a kontejner s názvem products. Kontejner products obsahuje podrobnosti, jako je název, kategorie, množství, jedinečný identifikátor a příznak prodeje pro každý produkt. Kontejner používá vlastnost /category jako klíč logické partice.

Ověření klienta

Tato ukázka vytvoří novou instanci CosmosClient, používá azcosmos.NewClient a ověřuje pomocí instance DefaultAzureCredential.

credential, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
    return err
}

clientOptions := azcosmos.ClientOptions{
    EnableContentResponseOnWrite: true,
}

client, err := azcosmos.NewClient("<azure-cosmos-db-nosql-account-endpoint>", credential, &clientOptions)
if err != nil {
    return err
}

Získání databáze

Slouží client.NewDatabase k načtení existující databáze s názvem cosmicworks.

database, err := client.NewDatabase("cosmicworks")
if err != nil {
    return err
}

Získání kontejneru

Načtení existujícího products kontejneru pomocí database.NewContainer.

container, err := database.NewContainer("products")
if err != nil {
    return err
}

Vytvoření položky

Sestavte typ Go se všemi členy, které chcete serializovat do formátu JSON. V tomto příkladu má typ jedinečný identifikátor a pole pro kategorii, název, množství, cenu a prodej.

type Item struct {
  Id        string  `json:"id"`
  Category  string  `json:"category"`
  Name      string  `json:"name"`
  Quantity  int     `json:"quantity"`
  Price     float32 `json:"price"`
  Clearance bool    `json:"clearance"`
}

Vytvoření položky v kontejneru pomocí container.UpsertItem. Tato metoda aktualizuje nebo vloží položku, přičemž účinně nahradí položku, pokud již existuje.

item := Item {
    Id:        "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    Category:  "gear-surf-surfboards",
    Name:      "Yamba Surfboard",
    Quantity:  12,
    Price:     850.00,
    Clearance: false,
}

partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

context := context.TODO()

bytes, err := json.Marshal(item)
if err != nil {
    return err
}

response, err := container.UpsertItem(context, partitionKey, bytes, nil)
if err != nil {
    return err
}

Přečtěte si položku

Proveďte čtení konkrétního bodu s využitím polí jedinečného identifikátoru (id) a klíče oddílu. Slouží container.ReadItem k efektivnímu načtení konkrétní položky.

partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

context := context.TODO()

itemId := "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"

response, err := container.ReadItem(context, partitionKey, itemId, nil)
if err != nil {
    return err
}

if response.RawResponse.StatusCode == 200 {
    read_item := Item{}
    err := json.Unmarshal(response.Value, &read_item)
    if err != nil {
        return err
    }
}

Položky dotazu

Proveďte dotaz na více položek v kontejneru pomocí container.NewQueryItemsPager. Pomocí tohoto parametrizovaného dotazu vyhledejte všechny položky v zadané kategorii:

SELECT * FROM products p WHERE p.category = @category
partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

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

queryOptions := azcosmos.QueryOptions{
    QueryParameters: []azcosmos.QueryParameter{
        {Name: "@category", Value: "gear-surf-surfboards"},
    },
}

pager := container.NewQueryItemsPager(query, partitionKey, &queryOptions)

Parsujte stránkované výsledky dotazu tak, že projdete každou stránku výsledků pomocí pager.NextPage. Použijte pager.More k určení, jestli na začátku každé smyčky zbývají nějaké výsledky.

items := []Item{}

for pager.More() {
    response, err := pager.NextPage(context.TODO())
    if err != nil {
        return err
    }

    for _, bytes := range response.Items {
        item := Item{}
        err := json.Unmarshal(bytes, &item)
        if err != nil {
            return err
        }
        items = append(items, item)
    }
}

Prozkoumání dat

K prozkoumání dat NoSQL použijte rozšíření Visual Studio Code pro Azure Cosmos DB. Můžete provádět základní databázové operace, mezi které patří mimo jiné:

  • Provádění dotazů pomocí poznámkového bloku nebo editoru dotazů
  • Úpravy, aktualizace, vytváření a odstraňování položek
  • Import hromadných dat z jiných zdrojů
  • Správa databází a kontejnerů

Další informace najdete v tématu Jak používat rozšíření Visual Studio Code k prozkoumání dat Azure Cosmos DB pro NoSQL.

Úklid prostředků

Pokud už ukázkovou aplikaci nebo prostředky nepotřebujete, odeberte odpovídající nasazení a všechny prostředky.

azd down