Go-SDK: verwaltete Datenbanken

c.Databases verwaltet die Managed Databases von Square Cloud (MongoDB, MySQL, PostgreSQL und Redis). Jede Methode nimmt zuerst ctx und, außer bei Create und StatusAll, danach die Datenbank-ID. Um deine Datenbanken aufzulisten, verwende c.Account.Me: Sein Slice Databases enthält jede Datenbank, die der Schlüssel sehen kann. Datenbank-Hosting erfordert einen Standard-, Pro- oder Enterprise-Plan. Jedes Snippet unten läuft für sich allein in diesem Programm: Füge jeweils eines in main ein und führe goimports aus (siehe Beispiele ausführen).

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

Eine Datenbank erstellen

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

Feld	Beschreibung
`Name` (`name`)	1 bis 32 Zeichen
`Type` (`type`)	`DatabaseMongo`, `DatabaseMySQL`, `DatabaseRedis` oder `DatabasePostgres` (`mongo`, `mysql`, `redis`, `postgres`)
`Version` (`version`)	Eine vollständige Version oder ein Präfix wie `"8"`
`Memory` (`memory`)	MB, ein `int`. Mindestens 512 für Redis und 1024 für die anderen

Das Ergebnis ist ein DatabaseCreated mit ID, Name, Memory, CPU (float64), Type, Password, Certificate (*string, nil, wenn die API keines sendet), ConnectionURL (connection_url) und Cluster. Passwort und Zertifikat werden nur von Create (und von ResetCredentials) zurückgegeben. Ohne Deadline auf ctx wartet der Aufruf mindestens 2 Minuten, bevor ein Timeout eintritt.

Status	Code	Wann
400	`INVALID_NAME`	Der Name hat nicht 1 bis 32 Zeichen
400	`INVALID_DATABASE_TYPE`, `INVALID_DATABASE_VERSION`	Unbekannter Typ oder nicht unterstützte Version
400	`INVALID_MEMORY`	`memory` ist keine ganze Zahl (ein Bruch oder ein String). `Memory` ist ein `int`, das Go SDK sendet also nie einen solchen Wert
400	`INSUFFICIENT_MEMORY`	`Memory` liegt unter dem Minimum der Engine oder übersteigt den verfügbaren Arbeitsspeicher
400	`CLUSTER_SELECTION_FAILED`	Kein Cluster hatte genug Kapazität
400 / 500	`DATABASE_CREATION_FAILED`	Die Bereitstellung ist fehlgeschlagen
403	`UPGRADE_REQUIRED`	Der Plan enthält kein Datenbank-Hosting
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Die Bereitstellung ist wegen Wartung pausiert

Eine Datenbank abrufen

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)

Eine Datenbank aktualisieren

Update(ctx, databaseID, squarecloud.DatabaseUpdate{Name, RAM}) benennt eine Datenbank um oder ändert ihre Größe. Felder mit Nullwert werden nicht gesendet; setze mindestens eines (sonst 400 NO_UPDATE_DATA).

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

Starten und Stoppen

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

Wie die Lebenszyklus-Aufrufe von Apps warten sie ohne Deadline auf ctx mindestens 2 Minuten, und eine Ablehnung ist 409 mit einem Code und einer leeren Nachricht: CONTAINER_ALREADY_STARTED, CONTAINER_ALREADY_STOPPED, CONTAINER_NOT_FOUND, CONTAINER_INSUFFICIENT_DISK_SPACE, CONTAINER_NETWORK_CONFLICT oder ACTION_FAILED. Während eine Snapshot-Wiederherstellung läuft, ergeben sie 403 RESTORE_IN_PROGRESS.

Status und Metriken

Status(ctx, databaseID) gibt formatierte Werte zurück; StatusRaw(ctx, databaseID) gibt Zahlen zurück. StatusAll(ctx) gibt eine Zusammenfassung pro Datenbank zurück. Metrics(ctx, databaseID) gibt die letzten 24 Stunden zurück, einen Punkt alle 5 Minuten, der neueste zuerst.

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

Die Statusfelder sind dieselben wie beim App-Status.

Zugangsdaten

Certificate(ctx, databaseID) gibt das TLS-Zertifikat als Base64-kodiertes PEM zurück. ResetCredentials(ctx, databaseID, reset) erneuert das Passwort (squarecloud.ResetPassword, gibt das neue zurück) oder das Zertifikat (squarecloud.ResetCertificate, gibt "" zurück). Die Datenbank muss laufen (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)
}

Eine Datenbank löschen

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

Das Löschen ist endgültig. Erstelle zuerst einen Snapshot, wenn du die Daten eventuell noch einmal brauchst.

Snapshots

c.Databases.Snapshots hat dieselben Methoden List, Create und Restore wie Apps. Siehe Snapshots.

Nächste Schritte

Workspaces

Apps mit deinem Team teilen.

API-Referenz für Datenbanken

Die REST-Endpunkte hinter diesen Methoden.

Datenbanken über die CLI

Dieselben Aktionen im Terminal.

CLI

VS Code

SDKs

Go-SDK: verwaltete Datenbanken

Eine Datenbank erstellen

Eine Datenbank abrufen

Eine Datenbank aktualisieren

Starten und Stoppen

Status und Metriken

Zugangsdaten

Eine Datenbank löschen

Snapshots

Nächste Schritte

Workspaces

API-Referenz für Datenbanken

Datenbanken über die CLI

​Eine Datenbank erstellen

​Eine Datenbank abrufen

​Eine Datenbank aktualisieren

​Starten und Stoppen

​Status und Metriken

​Zugangsdaten

​Eine Datenbank löschen

​Snapshots

​Nächste Schritte

Workspaces

API-Referenz für Datenbanken

Datenbanken über die CLI

Eine Datenbank erstellen

Eine Datenbank abrufen

Eine Datenbank aktualisieren

Starten und Stoppen

Status und Metriken

Zugangsdaten

Eine Datenbank löschen

Snapshots

Nächste Schritte