Краткое руководство. Использование Azure Cosmos DB для NoSQL с пакетом SDK Azure для Go

Мақала
11/09/2024
Қолданылады:

✅ NoSQL

В этом кратком руководстве описано, как развернуть базовое приложение Azure Cosmos DB для таблицы с помощью пакета SDK Azure для Go. Azure Cosmos DB для таблицы — это хранилище данных без схемы, позволяющее приложениям хранить структурированные данные таблицы в облаке. Вы узнаете, как создавать таблицы, строки и выполнять основные задачи в ресурсе Azure Cosmos DB с помощью пакета SDK Azure для Go.

Справочная документация по API: пакет исходного кода библиотеки | исходного кода | (Go) | Azure Developer CLI

Необходимые компоненты

Azure Developer CLI
Docker Desktop
Go 1.21 или более поздней версии

Если у вас нет учетной записи Azure, создайте бесплатную учетную запись, прежде чем начинать работу.

Инициализация проекта

Используйте интерфейс командной строки разработчика Azure (azd) для создания учетной записи Azure Cosmos DB для таблицы и развертывания контейнерного примера приложения. Пример приложения использует клиентская библиотека для управления, создания, чтения и запроса примеров данных.

Откройте терминал в пустом каталоге.
Если вы еще не прошли проверку подлинности, выполните проверку подлинности в интерфейсе командной строки разработчика Azure с помощью azd auth login. Выполните действия, указанные средством для проверки подлинности в CLI с помощью предпочитаемых учетных данных Azure.
```
azd auth login
```
Используется azd init для инициализации проекта.
```
azd init --template cosmos-db-nosql-go-quickstart
```
Во время инициализации настройте уникальное имя среды.
Разверните учетную запись Azure Cosmos DB с помощью azd up. Шаблоны Bicep также развертывают пример веб-приложения.
```
azd up
```
В процессе подготовки выберите подписку, требуемое расположение и целевую группу ресурсов. Дождитесь завершения процесса подготовки. Процесс может занять около пяти минут.

После завершения подготовки ресурсов Azure в выходные данные будет включен URL-адрес работающего веб-приложения.

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.

Используйте URL-адрес консоли для перехода к веб-приложению в браузере. Просмотрите выходные данные запущенного приложения.

Снимок экрана: работающее веб-приложение.

Установка клиентской библиотеки

Клиентская библиотека доступна через Go в качестве azcosmos пакета.

Откройте терминал и перейдите в папку /src .
```
cd ./src
```
Если пакет еще не установлен, установите azcosmos его с помощью go install.
```
go install github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
```
Кроме того, установите azidentity пакет, если он еще не установлен.
```
go install github.com/Azure/azure-sdk-for-go/sdk/azidentity
```
Откройте и просмотрите файл src/go.mod , чтобы убедиться, что github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos существуют и github.com/Azure/azure-sdk-for-go/sdk/azidentity записи.

Объектная модель

Имя	Описание
`CosmosClient`	Этот класс является основным клиентским классом и используется для управления метаданными или базами данных на уровне учетной записи.
`CosmosDatabase`	Этот класс представляет базу данных в учетной записи.
`CosmosContainer`	Этот класс в основном используется для выполнения операций чтения, обновления и удаления в контейнере или элементов, хранящихся в контейнере.
`PartitionKey`	Этот класс представляет ключ логического раздела. Этот класс необходим для многих распространенных операций и запросов.

Пример кода в шаблоне использует базу данных с именем cosmicworks и контейнером products. Контейнер products содержит такие сведения, как имя, категория, количество, уникальный идентификатор и флаг продажи для каждого продукта. Контейнер использует /category свойство в качестве ключа логического раздела.

аутентификация клиента;

В этом примере создается новый экземпляр CosmosClient использования azcosmos.NewClient и проверки подлинности с помощью экземпляра 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
}

Получение базы данных

Используется client.NewDatabase для извлечения существующей базы данных с именем cosmicworks.

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

Получение контейнера

Получение существующего products контейнера с помощью database.NewContainer.

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

Создание элемента

Создайте тип Go со всеми элементами, которые необходимо сериализовать в JSON. В этом примере тип имеет уникальный идентификатор и поля для категории, имени, количества, цены и продажи.

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

Создайте элемент в контейнере с помощью container.UpsertItem. Этот метод "upserts" элемент фактически заменяет элемент, если он уже существует.

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
}

Чтение элемента

Выполните операцию чтения точек с помощью полей уникального идентификатора (id) и ключа секции. Используется container.ReadItem для эффективного извлечения определенного элемента.

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

Элементы запроса

Выполнение запроса по нескольким элементам в контейнере с помощью container.NewQueryItemsPager. Найдите все элементы в указанной категории с помощью этого параметризованного запроса:

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)

Анализ результатов запроса с разбивкой на страницы путем цикла по каждой странице результатов с помощью pager.NextPage. Используется pager.More для определения наличия каких-либо результатов в начале каждого цикла.

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

Очистка ресурсов

Если вам больше не нужен пример приложения или ресурсов, удалите соответствующее развертывание и все ресурсы.

azd down

Бөлісу құралы:

Краткое руководство. Использование Azure Cosmos DB для NoSQL с пакетом SDK Azure для Go

Необходимые компоненты

Инициализация проекта

Установка клиентской библиотеки

Объектная модель

Примеры кода

аутентификация клиента;

Получение базы данных

Получение контейнера

Создание элемента

Чтение элемента

Элементы запроса

Очистка ресурсов

Кері байланыс

Қосымша ресурстар

Бөлісу құралы:

Краткое руководство. Использование Azure Cosmos DB для NoSQL с пакетом SDK Azure для Go

Необходимые компоненты

Инициализация проекта

Установка клиентской библиотеки

Объектная модель

Примеры кода

аутентификация клиента;

Получение базы данных

Получение контейнера

Создание элемента

Чтение элемента

Элементы запроса

Очистка ресурсов

Связанный контент

Кері байланыс

Қосымша ресурстар