Go SDK：托管数据库

c.Databases 管理 Square Cloud 的托管数据库（MongoDB、MySQL、PostgreSQL 和 Redis）。每个方法都以 ctx 作为第一个参数，除 Create 和 StatusAll 外，其次是数据库 ID。要列出你的数据库，请使用 c.Account.Me：它的 Databases 切片包含该密钥可见的所有数据库。数据库托管需要 Standard、Pro 或 Enterprise 套餐。下面的每个代码片段都可以在这个程序中单独运行：每次将一个片段粘贴到 main 中，然后运行 goimports（参见运行示例）。

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

创建数据库

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

字段	说明
`Name`（`name`）	1 到 32 个字符
`Type`（`type`）	`DatabaseMongo`、`DatabaseMySQL`、`DatabaseRedis` 或 `DatabasePostgres`（`mongo`、`mysql`、`redis`、`postgres`）
`Version`（`version`）	完整版本号或前缀，例如 `"8"`
`Memory`（`memory`）	MB，`int` 类型。Redis 至少 512，其他至少 1024

结果是一个 DatabaseCreated，包含 ID、Name、Memory、CPU（float64）、Type、Password、Certificate（*string，API 未发送时为 nil）、ConnectionURL（connection_url）和 Cluster。密码和证书仅由 Create（以及 ResetCredentials）返回。在 ctx 没有截止时间的情况下，该调用至少等待 2 分钟才会超时。

状态	代码	触发条件
400	`INVALID_NAME`	名称不在 1 到 32 个字符之间
400	`INVALID_DATABASE_TYPE`, `INVALID_DATABASE_VERSION`	未知类型或不支持的版本
400	`INVALID_MEMORY`	`memory` 不是整数（小数或字符串）。`Memory` 是 `int`，因此 Go SDK 永远不会发送此类值
400	`INSUFFICIENT_MEMORY`	`Memory` 低于该引擎的最小值或超过可用内存
400	`CLUSTER_SELECTION_FAILED`	没有集群具有足够的容量
400 / 500	`DATABASE_CREATION_FAILED`	资源配置失败
403	`UPGRADE_REQUIRED`	该套餐不支持数据库托管
503	`CLUSTER_MAINTENANCE_TRY_LATER`	资源配置因维护而暂停

获取数据库

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)

更新数据库

Update(ctx, databaseID, squarecloud.DatabaseUpdate{Name, RAM}) 重命名数据库或调整其大小。零值字段不会被发送；至少设置一个字段（否则返回 400 NO_UPDATE_DATA）。

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

启动和停止

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

与应用的生命周期调用一样，在 ctx 没有截止时间的情况下，它们至少等待 2 分钟，被拒绝时返回 409，带有代码和空消息：CONTAINER_ALREADY_STARTED、CONTAINER_ALREADY_STOPPED、CONTAINER_NOT_FOUND、CONTAINER_INSUFFICIENT_DISK_SPACE、CONTAINER_NETWORK_CONFLICT 或 ACTION_FAILED。在 snapshot 恢复进行期间，它们会返回 403 RESTORE_IN_PROGRESS。

状态和指标

Status(ctx, databaseID) 返回格式化的值；StatusRaw(ctx, databaseID) 返回数字。StatusAll(ctx) 为每个数据库返回一份摘要。Metrics(ctx, databaseID) 返回最近 24 小时的数据，每 5 分钟一个数据点，最新的在前。

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

状态字段与应用状态相同。

凭据

Certificate(ctx, databaseID) 以 base64 编码的 PEM 返回 TLS 证书。ResetCredentials(ctx, databaseID, reset) 轮换密码（squarecloud.ResetPassword，返回新密码）或证书（squarecloud.ResetCertificate，返回 ""）。数据库必须处于运行状态（否则返回 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)
}

删除数据库

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

删除是永久性的。如果你可能还需要这些数据，请先创建一个 snapshot。

Snapshots

c.Databases.Snapshots 拥有与应用相同的 List、Create 和 Restore。参见 Snapshots。

后续步骤

Workspaces

与团队共享应用。

数据库 API 参考

这些方法背后的 REST 端点。

用 CLI 管理数据库

在终端中完成同样的操作。

CLI

VS Code

SDKs

Go SDK：托管数据库

创建数据库

获取数据库

更新数据库

启动和停止

状态和指标

凭据

删除数据库

Snapshots

后续步骤

Workspaces

数据库 API 参考

用 CLI 管理数据库

​创建数据库

​获取数据库

​更新数据库

​启动和停止

​状态和指标

​凭据

​删除数据库

​Snapshots

​后续步骤

Workspaces

数据库 API 参考

用 CLI 管理数据库

创建数据库

获取数据库

更新数据库

启动和停止

状态和指标

凭据

删除数据库

Snapshots

后续步骤