Find all databases (Go)

Lists all databases.

You need an application token with permission to create and configure databases, such as the Organization Administrator role.

For more information, see Get endpoint and token.

Result

Returns a slice of FullAstraDatabaseInfo structs that each describe a database.

Parameters

Use the ListDatabases method, which belongs to the AstraAdmin type.

Method signature

func (a *AstraAdmin) ListDatabases(
  ctx context.Context,
  opts ...options.ListDatabasesOption
) ([]FullAstraDatabaseInfo, error)

Name Type Summary

Name	Type	Summary
`ctx`	`context.Context`	The context for the operation.
`opts`	`…options.ListDatabasesOption`	Optional. A builder to generate options for this operation. See Methods of the `ListDatabasesOption` builder for more details.

ctx

context.Context

The context for the operation.

opts

…options.ListDatabasesOption

Optional. A builder to generate options for this operation. See Methods of the ListDatabasesOption builder for more details.

Methods of the `ListDatabasesOption` builder
Method	Summary
`SetInclude(v options.DatabaseStatus)`	Optional. Filters the returned databases by status. Some database status are short-lived or do not apply to Astra DB Serverless databases. Default: `NONTERMINATED`
`SetProvider(v options.CloudProviderFilter)`	Optional. Filters the returned databases by cloud provider. Default: `ALL`
`SetLimit(v int)`	Optional. The number of results per page. Maximum: 100 Default: 25
`SetStartingAfter(v string)`	Optional. Pass the database ID of the last item on the previous page to get the next page.
`UpdateAPIOptions(v …APIOption)`	Optional. General API options for this operation, including the timeout.

Examples

The following examples demonstrate how to list databases.

package main

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

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/options"
)

func main() {
	ctx := context.Background()

	client := astra.NewClient(
		options.API().SetToken("APPLICATION_TOKEN"),
	)

	admin, err := client.Admin()

	if err != nil {
		log.Fatal(err)
	}

	databases, err := admin.ListDatabases(ctx)

	if err != nil {
		log.Fatal(err)
	}

	output, err := json.Marshal(databases)

	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(string(output))
}

Client reference

For more information, see the client reference.

Find all databases (Go)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback