Udostępnij przez


Szybki start: używanie usługi Azure Cosmos DB dla noSQL z zestawem Azure SDK dla języka Go

W tym szybkim starcie wdrożysz podstawową aplikację usługę Azure Cosmos DB for NoSQL, korzystając z Azure SDK dla języka Go. Usługa Azure Cosmos DB for NoSQL to bez schematu magazyn danych, który umożliwia aplikacjom przechowywanie danych bez struktury w chmurze. Wykonywanie zapytań dotyczących danych w kontenerach i wykonywanie typowych operacji na poszczególnych elementach przy użyciu zestawu Azure SDK dla języka Go.

Dokumentacja referencyjna API | Kod źródłowy biblioteki | Pakiet (Go) | Interfejs wiersza polecenia dla deweloperów platformy Azure

Wymagania wstępne

  • Azure Developer CLI
  • Docker Desktop
  • Go 1.21 lub nowszy

Jeśli nie masz jeszcze konta platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Inicjowanie projektu

Użyj interfejsu wiersza polecenia dla deweloperów platformy Azure (azd), aby utworzyć konto usługi Azure Cosmos DB for NoSQL i wdrożyć konteneryzowaną przykładową aplikację. Przykładowa aplikacja używa biblioteki klienta do zarządzania, tworzenia, odczytywania i wykonywania zapytań dotyczących przykładowych danych.

  1. Otwórz terminal w pustym katalogu.

  2. Jeśli jeszcze nie jesteś uwierzytelniony, uwierzytelnij się za pomocą Azure Developer CLI przy użyciu polecenia azd auth login. Wykonaj kroki określone przez narzędzie, aby uwierzytelnić się w interfejsie wiersza polecenia przy użyciu preferowanych poświadczeń platformy Azure.

    azd auth login
    
  3. Użyj azd init do zainicjowania projektu.

    azd init --template cosmos-db-nosql-go-quickstart
    
  4. Podczas inicjowania skonfiguruj unikatową nazwę środowiska.

  5. Wdróż konto usługi Azure Cosmos DB przy użyciu polecenia azd up. Szablony Bicep wdrażają również przykładową aplikację internetową.

    azd up
    
  6. Podczas procesu aprowizacji wybierz subskrypcję, żądaną lokalizację i docelową grupę zasobów. Poczekaj na zakończenie procesu konfiguracji. Proces może potrwać około pięciu minut.

  7. Po zakończeniu aprowizacji zasobów platformy Azure adres URL uruchomionej aplikacji internetowej zostanie uwzględniony w danych wyjściowych.

    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. Użyj adresu URL w konsoli, aby przejść do aplikacji internetowej w przeglądarce. Obserwuj dane wyjściowe uruchomionej aplikacji.

Zrzut ekranu przedstawiający uruchomioną aplikację internetową.

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna w języku Go jako pakiet azcosmos.

  1. Otwórz terminal i przejdź do /src folderu.

    cd ./src
    
  2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj azcosmos przy użyciu polecenia go install.

    go install github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
    
  3. Ponadto zainstaluj azidentity pakiet, jeśli nie został jeszcze zainstalowany.

    go install github.com/Azure/azure-sdk-for-go/sdk/azidentity
    
  4. Otwórz i przejrzyj plik src/go.mod, aby sprawdzić, czy istnieją oba wpisy github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos i github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Importowanie bibliotek

Zaimportuj pakiety github.com/Azure/azure-sdk-for-go/sdk/azidentity i github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos do kodu aplikacji.

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

Model obiektów

Name Description
CosmosClient Ta klasa jest podstawową klasą klienta i służy do zarządzania metadanymi lub bazami danych dla całego konta.
CosmosDatabase Ta klasa reprezentuje bazę danych w ramach konta.
CosmosContainer Ta klasa jest używana głównie do wykonywania operacji odczytu, aktualizacji i usuwania w kontenerze lub elementach przechowywanych w kontenerze.
PartitionKey Ta klasa reprezentuje klucz partycji logicznej. Ta klasa jest wymagana w przypadku wielu typowych operacji i zapytań.

Przykłady kodu

Przykładowy kod w szablonie używa bazy danych o nazwie cosmicworks oraz kontenera o nazwie products. Kontener products zawiera szczegóły, takie jak nazwa, kategoria, ilość, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Kontener używa właściwości /category jako logicznego klucza partycji.

Uwierzytelnianie klienta

Ten przykład tworzy nowe wystąpienie CosmosClient przy użyciu azcosmos.NewClient i uwierzytelnia się przy użyciu wystąpienia 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
}

Pobieranie bazy danych

Użyj client.NewDatabase polecenia , aby pobrać istniejącą bazę danych o nazwie cosmicworks.

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

Zdobądź kontener

Pobierz istniejący products kontener przy użyciu polecenia database.NewContainer.

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

Tworzenie elementu

Zbuduj typ Go z wszystkimi członkami, które chcesz serializować do formatu JSON. W tym przykładzie typ ma unikatowy identyfikator i pola dla kategorii, nazwy, ilości, ceny i sprzedaży.

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"`
}

Utwórz element w kontenerze przy użyciu polecenia container.UpsertItem. Ta metoda dodaje lub aktualizuje przedmiot, skutecznie zastępując go, jeśli już istnieje.

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
}

Przeczytaj element

Wykonaj operację odczytu punktowego, korzystając jednocześnie z pól unikatowego identyfikatora (id) oraz klucza partycji. Użyj container.ReadItem do wydajnego pobrania konkretnego elementu.

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

Elementy zapytania

Wykonaj zapytanie dotyczące wielu elementów w kontenerze przy użyciu polecenia container.NewQueryItemsPager. Znajdź wszystkie elementy w określonej kategorii przy użyciu tego sparametryzowanego zapytania:

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)

Przeanalizuj wyniki zapytania podzielonego na strony, wykonując pętlę na każdej stronie wyników przy użyciu polecenia pager.NextPage. Użyj pager.More, aby określić, czy na początku każdej pętli istnieją jakiekolwiek wyniki.

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

Eksplorowanie danych

Użyj rozszerzenia programu Visual Studio Code dla usługi Azure Cosmos DB, aby eksplorować dane NoSQL. Możesz wykonywać podstawowe operacje na bazie danych, w tym między innymi:

  • Wykonywanie zapytań przy użyciu albumu lub edytora zapytań
  • Modyfikowanie, aktualizowanie, tworzenie i usuwanie elementów
  • Importowanie danych zbiorczych z innych źródeł
  • Zarządzanie bazami danych i kontenerami

Aby uzyskać więcej informacji, zobacz How-to use Visual Studio Code extension to explore Azure Cosmos DB for NoSQL data (Jak używać rozszerzenia programu Visual Studio Code do eksplorowania danych usługi Azure Cosmos DB for NoSQL).

Uprzątnij zasoby

Jeśli nie potrzebujesz już przykładowej aplikacji lub zasobów, usuń odpowiednie wdrożenie i wszystkie zasoby.

azd down