Find available regions (Go)
Gets a list of available regions for database creation.
The clients only return regions that support vector databases.
To return other regions, use a direct HTTP request with the region-type query parameter.
|
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 astra.Region structs that contain information about the available regions.
Parameters
Use the FindAvailableRegions method, which belongs to the AstraAdmin type.
Method signature
func (a *AstraAdmin) FindAvailableRegions(
ctx context.Context,
opts ...options.FindAvailableRegionsOption
) ([]astra.Region, error)| Name | Type | Summary |
|---|---|---|
|
|
The context for the operation. |
|
Optional.
A builder to generate options for this operation.
See Methods of the |
| Method | Summary |
|---|---|
|
Optional. Whether to only return regions that can be used by the caller’s organization. Default: True |
|
Optional. General API options for this operation, including the timeout. |
Examples
The following examples demonstrate how to find available regions.
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)
}
regions, err := admin.FindAvailableRegions(ctx)
if err != nil {
log.Fatal(err)
}
output, err := json.Marshal(regions)
if err != nil {
log.Fatal(err)
}
fmt.Println(string(output))
}Client reference
For more information, see the client reference.
