Quickstart: Azure Cosmos DB for NoSQL library for Go

APPLIES TO: NoSQL

Get started with the Azure Cosmos DB for NoSQL client library for Go to query data in your containers and perform common operations on individual items. Follow these steps to deploy a minimal solution to your environment using the Azure Developer CLI.

API reference documentation | Library source code | Package (Go) | Azure Developer CLI

Prerequisites

Setting up

Deploy this project's development container to your environment. Then, use the Azure Developer CLI (azd) to create an Azure Cosmos DB for NoSQL account and deploy a containerized sample application. The sample application uses the client library to manage, create, read, and query sample data.

1. Open a terminal in the root directory of the project.

2. Authenticate to the Azure Developer CLI using azd auth login. Follow the steps specified by the tool to authenticate to the CLI using your preferred Azure credentials.

   azd auth login
   

3. Use azd init to initialize the project.

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

   Note

   This quickstart uses the azure-samples/cosmos-db-nosql-go-quickstart template GitHub repository. The Azure Developer CLI will automatically clone this project to your machine if it is not already there.

4. During initialization, configure a unique environment name.

   Tip

   The environment name will also be used as the target resource group name. For this quickstart, consider using msdocs-cosmos-db.

5. Deploy the Azure Cosmos DB account using azd up. The Bicep templates also deploy a sample web application.

   azd up
   

6. During the provisioning process, select your subscription and desired location. Wait for the provisioning process to complete. The process can take approximately five minutes.

7. Once the provisioning of your Azure resources is done, a URL to the running web application is included in the output.

   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. Use the URL in the console to navigate to your web application in the browser. Observe the output of the running app.

   

Install the client library

The client library is available through Go, as the azcosmos package.

1. Open a terminal and navigate to the /src folder.

   cd ./src
   

2. If not already installed, install the azcosmos package using go install.

   go install github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos
   

3. Also, install the azidentity package if not already installed.

   go install github.com/Azure/azure-sdk-for-go/sdk/azidentity
   

4. Open and review the src/go.mod file to validate that the github.com/Azure/azure-sdk-for-go/sdk/data/azcosmos and github.com/Azure/azure-sdk-for-go/sdk/azidentity entries both exist.

Object model

Code examples

• Authenticate the client
• Get a database
• Get a container
• Create an item
• Get an item
• Query items

The sample code in the template uses a database named cosmicworks and container named products. The products container contains details such as name, category, quantity, a unique identifier, and a sale flag for each product. The container uses the /category property as a logical partition key.

Authenticate the client

Application requests to most Azure services must be authorized. Use the DefaultAzureCredential type as the preferred way to implement a passwordless connection between your applications and Azure Cosmos DB for NoSQL. DefaultAzureCredential supports multiple authentication methods and determines which method should be used at runtime.

This sample creates a new instance of CosmosClient using azcosmos.NewClient and authenticates using a DefaultAzureCredential instance.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

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

func startCosmos(writeOutput func(msg string)) error {
	endpoint := os.Getenv("COSMOS_DB_ENDPOINT")
	log.Println("ENDPOINT:", endpoint)

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

	clientOptions := azcosmos.ClientOptions{
		EnableContentResponseOnWrite: true,
	}
	
	client, err := azcosmos.NewClient(endpoint, credential, &clientOptions)
	if err != nil {
		return err
	}
	// </create_client>
	writeOutput("Current Status:\tStarting...")

	// <get_database>
	database, err := client.NewDatabase("cosmicworks")
	if err != nil {
		return err
	}
	// </get_database>
	writeOutput(fmt.Sprintf("Get database:\t%s", database.ID()))

	// <get_container>
	container, err := database.NewContainer("products")
	if err != nil {
		return err
	}
	// </get_container>
	writeOutput(fmt.Sprintf("Get container:\t%s", container.ID()))

	{
		// <create_item>
		item := Item {
			Id:			"70b63682-b93a-4c77-aad2-65501347265f",
			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
		}
		// </create_item>	
		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		item := Item {
			Id:			"25a68543-b90c-439d-8332-7ef41e06a0e0",
			Category:	"gear-surf-surfboards",
			Name:		"Kiama Classic Surfboard",
			Quantity:	25,
			Price:		790.00,
			Clearance:	true,
		}

		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
		}

		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	
	}

	{
		// <read_item>
		partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

		context := context.TODO()

		itemId := "70b63682-b93a-4c77-aad2-65501347265f"

		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
			}
			// </read_item>
			writeOutput(fmt.Sprintf("Read item id:\t%s", read_item.Id))
			writeOutput(fmt.Sprintf("Read item:\t%v", read_item))
		}

		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		// <query_items>
		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)
		// </query_items>

		// <parse_results>
		context := context.TODO()

		items := []Item{}

		requestCharge := float32(0)

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

			requestCharge += response.RequestCharge

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

		for _, item := range items {
			writeOutput(fmt.Sprintf("Found item:\t%s\t%s", item.Name, item.Id))
		}
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", requestCharge))
	}

	return nil
}

Get a database

Use client.NewDatabase to retrieve the existing database named cosmicworks.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

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

func startCosmos(writeOutput func(msg string)) error {
	endpoint := os.Getenv("COSMOS_DB_ENDPOINT")
	log.Println("ENDPOINT:", endpoint)

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

	clientOptions := azcosmos.ClientOptions{
		EnableContentResponseOnWrite: true,
	}
	
	client, err := azcosmos.NewClient(endpoint, credential, &clientOptions)
	if err != nil {
		return err
	}
	// </create_client>
	writeOutput("Current Status:\tStarting...")

	// <get_database>
	database, err := client.NewDatabase("cosmicworks")
	if err != nil {
		return err
	}
	// </get_database>
	writeOutput(fmt.Sprintf("Get database:\t%s", database.ID()))

	// <get_container>
	container, err := database.NewContainer("products")
	if err != nil {
		return err
	}
	// </get_container>
	writeOutput(fmt.Sprintf("Get container:\t%s", container.ID()))

	{
		// <create_item>
		item := Item {
			Id:			"70b63682-b93a-4c77-aad2-65501347265f",
			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
		}
		// </create_item>	
		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		item := Item {
			Id:			"25a68543-b90c-439d-8332-7ef41e06a0e0",
			Category:	"gear-surf-surfboards",
			Name:		"Kiama Classic Surfboard",
			Quantity:	25,
			Price:		790.00,
			Clearance:	true,
		}

		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
		}

		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	
	}

	{
		// <read_item>
		partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

		context := context.TODO()

		itemId := "70b63682-b93a-4c77-aad2-65501347265f"

		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
			}
			// </read_item>
			writeOutput(fmt.Sprintf("Read item id:\t%s", read_item.Id))
			writeOutput(fmt.Sprintf("Read item:\t%v", read_item))
		}

		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		// <query_items>
		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)
		// </query_items>

		// <parse_results>
		context := context.TODO()

		items := []Item{}

		requestCharge := float32(0)

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

			requestCharge += response.RequestCharge

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

		for _, item := range items {
			writeOutput(fmt.Sprintf("Found item:\t%s\t%s", item.Name, item.Id))
		}
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", requestCharge))
	}

	return nil
}

Get a container

Retrieve the existing products container using database.NewContainer.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

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

func startCosmos(writeOutput func(msg string)) error {
	endpoint := os.Getenv("COSMOS_DB_ENDPOINT")
	log.Println("ENDPOINT:", endpoint)

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

	clientOptions := azcosmos.ClientOptions{
		EnableContentResponseOnWrite: true,
	}
	
	client, err := azcosmos.NewClient(endpoint, credential, &clientOptions)
	if err != nil {
		return err
	}
	// </create_client>
	writeOutput("Current Status:\tStarting...")

	// <get_database>
	database, err := client.NewDatabase("cosmicworks")
	if err != nil {
		return err
	}
	// </get_database>
	writeOutput(fmt.Sprintf("Get database:\t%s", database.ID()))

	// <get_container>
	container, err := database.NewContainer("products")
	if err != nil {
		return err
	}
	// </get_container>
	writeOutput(fmt.Sprintf("Get container:\t%s", container.ID()))

	{
		// <create_item>
		item := Item {
			Id:			"70b63682-b93a-4c77-aad2-65501347265f",
			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
		}
		// </create_item>	
		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		item := Item {
			Id:			"25a68543-b90c-439d-8332-7ef41e06a0e0",
			Category:	"gear-surf-surfboards",
			Name:		"Kiama Classic Surfboard",
			Quantity:	25,
			Price:		790.00,
			Clearance:	true,
		}

		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
		}

		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	
	}

	{
		// <read_item>
		partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

		context := context.TODO()

		itemId := "70b63682-b93a-4c77-aad2-65501347265f"

		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
			}
			// </read_item>
			writeOutput(fmt.Sprintf("Read item id:\t%s", read_item.Id))
			writeOutput(fmt.Sprintf("Read item:\t%v", read_item))
		}

		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		// <query_items>
		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)
		// </query_items>

		// <parse_results>
		context := context.TODO()

		items := []Item{}

		requestCharge := float32(0)

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

			requestCharge += response.RequestCharge

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

		for _, item := range items {
			writeOutput(fmt.Sprintf("Found item:\t%s\t%s", item.Name, item.Id))
		}
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", requestCharge))
	}

	return nil
}

Create an item

Build a Go type with all of the members you want to serialize into JSON. In this example, the type has a unique identifier, and fields for category, name, quantity, price, and sale.

package main

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

Create an item in the container using container.UpsertItem. This method "upserts" the item effectively replacing the item if it already exists.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

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

func startCosmos(writeOutput func(msg string)) error {
	endpoint := os.Getenv("COSMOS_DB_ENDPOINT")
	log.Println("ENDPOINT:", endpoint)

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

	clientOptions := azcosmos.ClientOptions{
		EnableContentResponseOnWrite: true,
	}
	
	client, err := azcosmos.NewClient(endpoint, credential, &clientOptions)
	if err != nil {
		return err
	}
	// </create_client>
	writeOutput("Current Status:\tStarting...")

	// <get_database>
	database, err := client.NewDatabase("cosmicworks")
	if err != nil {
		return err
	}
	// </get_database>
	writeOutput(fmt.Sprintf("Get database:\t%s", database.ID()))

	// <get_container>
	container, err := database.NewContainer("products")
	if err != nil {
		return err
	}
	// </get_container>
	writeOutput(fmt.Sprintf("Get container:\t%s", container.ID()))

	{
		// <create_item>
		item := Item {
			Id:			"70b63682-b93a-4c77-aad2-65501347265f",
			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
		}
		// </create_item>	
		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		item := Item {
			Id:			"25a68543-b90c-439d-8332-7ef41e06a0e0",
			Category:	"gear-surf-surfboards",
			Name:		"Kiama Classic Surfboard",
			Quantity:	25,
			Price:		790.00,
			Clearance:	true,
		}

		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
		}

		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	
	}

	{
		// <read_item>
		partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

		context := context.TODO()

		itemId := "70b63682-b93a-4c77-aad2-65501347265f"

		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
			}
			// </read_item>
			writeOutput(fmt.Sprintf("Read item id:\t%s", read_item.Id))
			writeOutput(fmt.Sprintf("Read item:\t%v", read_item))
		}

		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		// <query_items>
		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)
		// </query_items>

		// <parse_results>
		context := context.TODO()

		items := []Item{}

		requestCharge := float32(0)

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

			requestCharge += response.RequestCharge

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

		for _, item := range items {
			writeOutput(fmt.Sprintf("Found item:\t%s\t%s", item.Name, item.Id))
		}
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", requestCharge))
	}

	return nil
}

Read an item

Perform a point read operation by using both the unique identifier (id) and partition key fields. Use container.ReadItem to efficiently retrieve the specific item.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

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

func startCosmos(writeOutput func(msg string)) error {
	endpoint := os.Getenv("COSMOS_DB_ENDPOINT")
	log.Println("ENDPOINT:", endpoint)

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

	clientOptions := azcosmos.ClientOptions{
		EnableContentResponseOnWrite: true,
	}
	
	client, err := azcosmos.NewClient(endpoint, credential, &clientOptions)
	if err != nil {
		return err
	}
	// </create_client>
	writeOutput("Current Status:\tStarting...")

	// <get_database>
	database, err := client.NewDatabase("cosmicworks")
	if err != nil {
		return err
	}
	// </get_database>
	writeOutput(fmt.Sprintf("Get database:\t%s", database.ID()))

	// <get_container>
	container, err := database.NewContainer("products")
	if err != nil {
		return err
	}
	// </get_container>
	writeOutput(fmt.Sprintf("Get container:\t%s", container.ID()))

	{
		// <create_item>
		item := Item {
			Id:			"70b63682-b93a-4c77-aad2-65501347265f",
			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
		}
		// </create_item>	
		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		item := Item {
			Id:			"25a68543-b90c-439d-8332-7ef41e06a0e0",
			Category:	"gear-surf-surfboards",
			Name:		"Kiama Classic Surfboard",
			Quantity:	25,
			Price:		790.00,
			Clearance:	true,
		}

		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
		}

		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	
	}

	{
		// <read_item>
		partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

		context := context.TODO()

		itemId := "70b63682-b93a-4c77-aad2-65501347265f"

		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
			}
			// </read_item>
			writeOutput(fmt.Sprintf("Read item id:\t%s", read_item.Id))
			writeOutput(fmt.Sprintf("Read item:\t%v", read_item))
		}

		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		// <query_items>
		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)
		// </query_items>

		// <parse_results>
		context := context.TODO()

		items := []Item{}

		requestCharge := float32(0)

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

			requestCharge += response.RequestCharge

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

		for _, item := range items {
			writeOutput(fmt.Sprintf("Found item:\t%s\t%s", item.Name, item.Id))
		}
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", requestCharge))
	}

	return nil
}

Query items

Perform a query over multiple items in a container using container.NewQueryItemsPager. Find all items within a specified category using this parameterized query:

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

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

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

func startCosmos(writeOutput func(msg string)) error {
	endpoint := os.Getenv("COSMOS_DB_ENDPOINT")
	log.Println("ENDPOINT:", endpoint)

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

	clientOptions := azcosmos.ClientOptions{
		EnableContentResponseOnWrite: true,
	}
	
	client, err := azcosmos.NewClient(endpoint, credential, &clientOptions)
	if err != nil {
		return err
	}
	// </create_client>
	writeOutput("Current Status:\tStarting...")

	// <get_database>
	database, err := client.NewDatabase("cosmicworks")
	if err != nil {
		return err
	}
	// </get_database>
	writeOutput(fmt.Sprintf("Get database:\t%s", database.ID()))

	// <get_container>
	container, err := database.NewContainer("products")
	if err != nil {
		return err
	}
	// </get_container>
	writeOutput(fmt.Sprintf("Get container:\t%s", container.ID()))

	{
		// <create_item>
		item := Item {
			Id:			"70b63682-b93a-4c77-aad2-65501347265f",
			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
		}
		// </create_item>	
		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		item := Item {
			Id:			"25a68543-b90c-439d-8332-7ef41e06a0e0",
			Category:	"gear-surf-surfboards",
			Name:		"Kiama Classic Surfboard",
			Quantity:	25,
			Price:		790.00,
			Clearance:	true,
		}

		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
		}

		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	
	}

	{
		// <read_item>
		partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

		context := context.TODO()

		itemId := "70b63682-b93a-4c77-aad2-65501347265f"

		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
			}
			// </read_item>
			writeOutput(fmt.Sprintf("Read item id:\t%s", read_item.Id))
			writeOutput(fmt.Sprintf("Read item:\t%v", read_item))
		}

		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		// <query_items>
		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)
		// </query_items>

		// <parse_results>
		context := context.TODO()

		items := []Item{}

		requestCharge := float32(0)

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

			requestCharge += response.RequestCharge

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

		for _, item := range items {
			writeOutput(fmt.Sprintf("Found item:\t%s\t%s", item.Name, item.Id))
		}
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", requestCharge))
	}

	return nil
}

Parse the paginated results of the query by looping through each page of results using pager.NextPage. Use pager.More to determine if there are any results left at the start of each loop.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"

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

func startCosmos(writeOutput func(msg string)) error {
	endpoint := os.Getenv("COSMOS_DB_ENDPOINT")
	log.Println("ENDPOINT:", endpoint)

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

	clientOptions := azcosmos.ClientOptions{
		EnableContentResponseOnWrite: true,
	}
	
	client, err := azcosmos.NewClient(endpoint, credential, &clientOptions)
	if err != nil {
		return err
	}
	// </create_client>
	writeOutput("Current Status:\tStarting...")

	// <get_database>
	database, err := client.NewDatabase("cosmicworks")
	if err != nil {
		return err
	}
	// </get_database>
	writeOutput(fmt.Sprintf("Get database:\t%s", database.ID()))

	// <get_container>
	container, err := database.NewContainer("products")
	if err != nil {
		return err
	}
	// </get_container>
	writeOutput(fmt.Sprintf("Get container:\t%s", container.ID()))

	{
		// <create_item>
		item := Item {
			Id:			"70b63682-b93a-4c77-aad2-65501347265f",
			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
		}
		// </create_item>	
		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		item := Item {
			Id:			"25a68543-b90c-439d-8332-7ef41e06a0e0",
			Category:	"gear-surf-surfboards",
			Name:		"Kiama Classic Surfboard",
			Quantity:	25,
			Price:		790.00,
			Clearance:	true,
		}

		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
		}

		if response.RawResponse.StatusCode == 200 || response.RawResponse.StatusCode == 201 {
			created_item := Item{}
			err := json.Unmarshal(response.Value, &created_item)
			if err != nil {
				return err
			}
			writeOutput(fmt.Sprintf("Upserted item:\t%v", created_item))
		}
		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	
	}

	{
		// <read_item>
		partitionKey := azcosmos.NewPartitionKeyString("gear-surf-surfboards")

		context := context.TODO()

		itemId := "70b63682-b93a-4c77-aad2-65501347265f"

		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
			}
			// </read_item>
			writeOutput(fmt.Sprintf("Read item id:\t%s", read_item.Id))
			writeOutput(fmt.Sprintf("Read item:\t%v", read_item))
		}

		writeOutput(fmt.Sprintf("Status code:\t%d", response.RawResponse.StatusCode))
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", response.RequestCharge))
	}

	{
		// <query_items>
		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)
		// </query_items>

		// <parse_results>
		context := context.TODO()

		items := []Item{}

		requestCharge := float32(0)

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

			requestCharge += response.RequestCharge

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

		for _, item := range items {
			writeOutput(fmt.Sprintf("Found item:\t%s\t%s", item.Name, item.Id))
		}
		writeOutput(fmt.Sprintf("Request charge:\t%.2f", requestCharge))
	}

	return nil
}

Clean up resources

azd down

Related content

• .NET Quickstart
• Node.js Quickstart
• Java Quickstart
• Python Quickstart

Next step