SDK de Go: bases de datos gestionadas

c.Databases gestiona las bases de datos gestionadas de Square Cloud (MongoDB, MySQL, PostgreSQL y Redis). Todos los métodos reciben primero ctx y, salvo Create y StatusAll, después el id de la base de datos. Para listar tus bases de datos, usa c.Account.Me: su slice Databases contiene todas las bases de datos que la clave puede ver. El alojamiento de bases de datos requiere un plan Standard, Pro o Enterprise. Cada fragmento de abajo se ejecuta por sí solo dentro de este programa: pega uno a la vez en main y ejecuta goimports (consulta Ejecutar los ejemplos).

package main

import (
	"context"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

var (
	ctx        = context.Background()
	c          = squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))
	databaseID = "abc123def456abc123def456"
)

func main() {
	// Paste one snippet here, then run goimports.
}

Crear una base de datos

db, err := c.Databases.Create(ctx, squarecloud.DatabaseCreate{
	Name:    "my-db",
	Type:    squarecloud.DatabasePostgres, // DatabaseMongo, DatabaseMySQL, DatabaseRedis, DatabasePostgres
	Version: "17",                         // a full version or a prefix
	Memory:  1024,                         // MB
})
if err != nil {
	log.Fatal(err)
}

fmt.Println(db.ID, db.ConnectionURL, db.Cluster)
fmt.Println(db.Password) // shown only here: save it
if db.Certificate != nil {
	fmt.Println(*db.Certificate) // base64 PEM (private key, then certificate)
}

Campo	Descripción
`Name` (`name`)	De 1 a 32 caracteres
`Type` (`type`)	`DatabaseMongo`, `DatabaseMySQL`, `DatabaseRedis` o `DatabasePostgres` (`mongo`, `mysql`, `redis`, `postgres`)
`Version` (`version`)	Una versión completa o un prefijo como `"8"`
`Memory` (`memory`)	MB, un `int`. Al menos 512 para Redis y 1024 para los demás

El resultado es un DatabaseCreated con ID, Name, Memory, CPU (float64), Type, Password, Certificate (*string, nil cuando la API no envía ninguno), ConnectionURL (connection_url) y Cluster. La contraseña y el certificado solo los devuelve Create (y ResetCredentials). Sin un deadline en ctx, la llamada espera al menos 2 minutos antes de agotar el tiempo.

Estado	Código	Cuándo
400	`INVALID_NAME`	El nombre no tiene entre 1 y 32 caracteres
400	`INVALID_DATABASE_TYPE`, `INVALID_DATABASE_VERSION`	Tipo desconocido o versión no soportada
400	`INVALID_MEMORY`	`memory` no es un número entero (una fracción o un string). `Memory` es un `int`, así que el SDK de Go nunca envía uno
400	`INSUFFICIENT_MEMORY`	`Memory` está por debajo del mínimo del motor o supera la memoria disponible
400	`CLUSTER_SELECTION_FAILED`	Ningún clúster tenía capacidad suficiente
400 / 500	`DATABASE_CREATION_FAILED`	Falló el aprovisionamiento
403	`UPGRADE_REQUIRED`	El plan no incluye alojamiento de bases de datos
503	`CLUSTER_MAINTENANCE_TRY_LATER`	El aprovisionamiento está en pausa por mantenimiento

Obtener una base de datos

db, err := c.Databases.Get(ctx, databaseID)
if err != nil {
	log.Fatal(err)
}

fmt.Println(db.ID, db.Name, db.Type, db.RAM, db.Port, db.Cluster, db.CreatedAt)

Actualizar una base de datos

Update(ctx, databaseID, squarecloud.DatabaseUpdate{Name, RAM}) renombra o redimensiona una base de datos. Los campos con valor cero no se envían; define al menos uno (en caso contrario, 400 NO_UPDATE_DATA).

if err := c.Databases.Update(ctx, databaseID, squarecloud.DatabaseUpdate{Name: "orders", RAM: 2048}); err != nil {
	log.Fatal(err)
}

Iniciar y detener

if err := c.Databases.Start(ctx, databaseID); err != nil {
	log.Fatal(err)
}
if err := c.Databases.Stop(ctx, databaseID); err != nil {
	log.Fatal(err)
}

Al igual que las llamadas del ciclo de vida de las aplicaciones, sin un deadline en ctx esperan al menos 2 minutos, y un rechazo es un 409 con un código y un mensaje vacío: CONTAINER_ALREADY_STARTED, CONTAINER_ALREADY_STOPPED, CONTAINER_NOT_FOUND, CONTAINER_INSUFFICIENT_DISK_SPACE, CONTAINER_NETWORK_CONFLICT o ACTION_FAILED. Mientras se ejecuta la restauración de un snapshot, dan 403 RESTORE_IN_PROGRESS.

Estado y métricas

Status(ctx, databaseID) devuelve valores formateados; StatusRaw(ctx, databaseID) devuelve números. StatusAll(ctx) devuelve un resumen por base de datos. Metrics(ctx, databaseID) devuelve las últimas 24 horas, un punto cada 5 minutos, del más reciente al más antiguo.

status, err := c.Databases.Status(ctx, databaseID)
if err != nil {
	log.Fatal(err)
}
fmt.Println(status.Running, status.CPU, status.RAM) // true "0.5%" "120.4MB"

raw, err := c.Databases.StatusRaw(ctx, databaseID)
if err != nil {
	log.Fatal(err)
}
fmt.Println(raw.CPU, raw.RAM) // 0.5 120.4

items, err := c.Databases.StatusAll(ctx)
if err != nil {
	log.Fatal(err)
}
for _, it := range items {
	fmt.Println(it.ID, it.Running, it.CPU, it.RAM) // CPU and RAM only while running
}

points, err := c.Databases.Metrics(ctx, databaseID)
if err != nil {
	log.Fatal(err)
}
if len(points) > 0 {
	fmt.Println(points[0].Date, points[0].CPU, points[0].RAM)
}

Los campos de estado son los mismos que los del estado de las aplicaciones.

Credenciales

Certificate(ctx, databaseID) devuelve el certificado TLS como PEM codificado en base64. ResetCredentials(ctx, databaseID, reset) rota la contraseña (squarecloud.ResetPassword, devuelve la nueva) o el certificado (squarecloud.ResetCertificate, devuelve ""). La base de datos debe estar en ejecución (400 DATABASE_NOT_RUNNING).

certificate, err := c.Databases.Certificate(ctx, databaseID)
if err != nil {
	log.Fatal(err)
}
pem, err := base64.StdEncoding.DecodeString(certificate)
if err != nil {
	log.Fatal(err)
}
if err := os.WriteFile("database.pem", pem, 0o600); err != nil {
	log.Fatal(err)
}

password, err := c.Databases.ResetCredentials(ctx, databaseID, squarecloud.ResetPassword)
if err != nil {
	log.Fatal(err)
}
fmt.Println(password) // the new password: save it

if _, err := c.Databases.ResetCredentials(ctx, databaseID, squarecloud.ResetCertificate); err != nil {
	log.Fatal(err)
}

Eliminar una base de datos

if err := c.Databases.Delete(ctx, databaseID); err != nil {
	log.Fatal(err)
}

La eliminación es permanente. Toma primero un snapshot si es posible que vuelvas a necesitar los datos.

Snapshots

c.Databases.Snapshots tiene los mismos List, Create y Restore que las aplicaciones. Consulta Snapshots.

Próximos pasos

Workspaces

Comparte aplicaciones con tu equipo.

Referencia de la API de bases de datos

Los endpoints REST detrás de estos métodos.

Bases de datos desde la CLI

Las mismas acciones desde la terminal.

CLI

VS Code

SDKs

SDK de Go: bases de datos gestionadas

Crear una base de datos

Obtener una base de datos

Actualizar una base de datos

Iniciar y detener

Estado y métricas

Credenciales

Eliminar una base de datos

Snapshots

Próximos pasos

Workspaces

Referencia de la API de bases de datos

Bases de datos desde la CLI

​Crear una base de datos

​Obtener una base de datos

​Actualizar una base de datos

​Iniciar y detener

​Estado y métricas

​Credenciales

​Eliminar una base de datos

​Snapshots

​Próximos pasos

Workspaces

Referencia de la API de bases de datos

Bases de datos desde la CLI

Crear una base de datos

Obtener una base de datos

Actualizar una base de datos

Iniciar y detener

Estado y métricas

Credenciales

Eliminar una base de datos

Snapshots

Próximos pasos