PgBeam Docs
Databases

GetDatabase

Get a database

Returns a single database by ID.

Usage

result, err := client.Databases.GetDatabase(ctx)

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context

Response

(*pgbeam.Database, error) — database found.

Example

import pgbeam "github.com/pgbeam/pgbeam-go"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pgb_your_api_key",
})

result, err := client.Databases.GetDatabase(ctx)
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.
429Rate limited. Try again later.

On this page