SDK Go : bases de données gérées

c.Databases gère les bases de données gérées de Square Cloud (MongoDB, MySQL, PostgreSQL et Redis). Chaque méthode prend d’abord ctx puis, sauf Create et StatusAll, l’identifiant de la base de données. Pour lister vos bases de données, utilisez c.Account.Me : sa slice Databases contient toutes les bases de données que la clé peut voir. L’hébergement de bases de données nécessite un plan Standard, Pro ou Enterprise. Chaque extrait ci-dessous s’exécute seul dans ce programme : collez-en un à la fois dans main et lancez goimports (voir Exécuter les exemples).

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.
}

Créer une base de données

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)
}

Champ	Description
`Name` (`name`)	De 1 à 32 caractères
`Type` (`type`)	`DatabaseMongo`, `DatabaseMySQL`, `DatabaseRedis` ou `DatabasePostgres` (`mongo`, `mysql`, `redis`, `postgres`)
`Version` (`version`)	Une version complète ou un préfixe comme `"8"`
`Memory` (`memory`)	Mo, un `int`. Au moins 512 pour Redis et 1024 pour les autres

Le résultat est un DatabaseCreated avec ID, Name, Memory, CPU (float64), Type, Password, Certificate (*string, nil quand l’API n’en envoie pas), ConnectionURL (connection_url) et Cluster. Le mot de passe et le certificat ne sont renvoyés que par Create (et par ResetCredentials). Sans échéance sur ctx, l’appel attend au moins 2 minutes avant d’expirer.

Statut	Code	Quand
400	`INVALID_NAME`	Le nom ne fait pas de 1 à 32 caractères
400	`INVALID_DATABASE_TYPE`, `INVALID_DATABASE_VERSION`	Type inconnu ou version non prise en charge
400	`INVALID_MEMORY`	`memory` n’est pas un nombre entier (une fraction ou une chaîne). `Memory` est un `int` : le SDK Go n’en envoie donc jamais
400	`INSUFFICIENT_MEMORY`	`Memory` est inférieur au minimum du moteur ou dépasse la mémoire disponible
400	`CLUSTER_SELECTION_FAILED`	Aucun cluster n’avait assez de capacité
400 / 500	`DATABASE_CREATION_FAILED`	Le provisionnement a échoué
403	`UPGRADE_REQUIRED`	Le plan n’inclut pas l’hébergement de bases de données
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Le provisionnement est suspendu pour maintenance

Récupérer une base de données

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)

Mettre à jour une base de données

Update(ctx, databaseID, squarecloud.DatabaseUpdate{Name, RAM}) renomme ou redimensionne une base de données. Les champs à la valeur zéro ne sont pas envoyés ; définissez-en au moins un (400 NO_UPDATE_DATA sinon).

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

Démarrer et arrêter

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

Comme les appels de cycle de vie des applications, sans échéance sur ctx ils attendent au moins 2 minutes, et un refus donne 409 avec un code et un message vide : CONTAINER_ALREADY_STARTED, CONTAINER_ALREADY_STOPPED, CONTAINER_NOT_FOUND, CONTAINER_INSUFFICIENT_DISK_SPACE, CONTAINER_NETWORK_CONFLICT ou ACTION_FAILED. Pendant la restauration d’un snapshot, ils donnent 403 RESTORE_IN_PROGRESS.

Statut et métriques

Status(ctx, databaseID) renvoie des valeurs formatées ; StatusRaw(ctx, databaseID) renvoie des nombres. StatusAll(ctx) renvoie un résumé par base de données. Metrics(ctx, databaseID) renvoie les dernières 24 heures, un point toutes les 5 minutes, du plus récent au plus ancien.

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)
}

Les champs de statut sont les mêmes que pour le statut des applications.

Identifiants

Certificate(ctx, databaseID) renvoie le certificat TLS en PEM encodé en base64. ResetCredentials(ctx, databaseID, reset) renouvelle le mot de passe (squarecloud.ResetPassword, renvoie le nouveau) ou le certificat (squarecloud.ResetCertificate, renvoie ""). La base de données doit être en cours d’exécution (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)
}

Supprimer une base de données

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

La suppression est définitive. Prenez d’abord un snapshot si vous risquez d’avoir de nouveau besoin des données.

Snapshots

c.Databases.Snapshots dispose des mêmes List, Create et Restore que les applications. Voir Snapshots.

Prochaines étapes

Workspaces

Partagez des applications avec votre équipe.

Référence de l'API des bases de données

Les endpoints REST derrière ces méthodes.

Bases de données depuis la CLI

Les mêmes actions depuis le terminal.

CLI

VS Code

SDKs

SDK Go : bases de données gérées

Créer une base de données

Récupérer une base de données

Mettre à jour une base de données

Démarrer et arrêter

Statut et métriques

Identifiants

Supprimer une base de données

Snapshots

Prochaines étapes

Workspaces

Référence de l'API des bases de données

Bases de données depuis la CLI

​Créer une base de données

​Récupérer une base de données

​Mettre à jour une base de données

​Démarrer et arrêter

​Statut et métriques

​Identifiants

​Supprimer une base de données

​Snapshots

​Prochaines étapes

Workspaces

Référence de l'API des bases de données

Bases de données depuis la CLI

Créer une base de données

Récupérer une base de données

Mettre à jour une base de données

Démarrer et arrêter

Statut et métriques

Identifiants

Supprimer une base de données

Snapshots

Prochaines étapes