SDK de Python: bases de datos gestionadas

client.databases gestiona las bases de datos gestionadas de Square Cloud (MongoDB, MySQL, PostgreSQL y Redis). Todos los métodos salvo create y status_all reciben primero el id de la base de datos. Para listar tus bases de datos, usa client.account.me(): su lista 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. Los ejemplos usan el client de Crear el cliente. database_id es el id de una de tus bases de datos: client.account.me() las lista.

Crear una base de datos

databases.create(name, type=, version=, memory=) recibe el nombre por posición y los demás campos como argumentos solo por palabra clave.

db = client.databases.create(
    "my-db",
    type="postgres",  # "mongo" | "mysql" | "redis" | "postgres"
    version="17",     # a full version or a prefix
    memory=1024,      # MB, an int
)

print(db["id"], db["connection_url"], db["cluster"])
print(db["password"])            # shown only here: save it
print(db.get("certificate"))     # base64 PEM (private key, then certificate), or None

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

El password y el certificate solo los devuelve create() (y reset_credentials()). La llamada espera al menos 120 s 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 `int` (un `float` o un string)
400	`INSUFFICIENT_MEMORY`	`memory` está por debajo del mínimo 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 = client.databases.get(database_id)

print(db["id"], db["name"], db["type"], db["ram"], db["port"], db["cluster"], db["created_at"])

Actualizar una base de datos

update(database_id, name=None, ram=None) renombra o redimensiona una base de datos. Ambos argumentos son solo por palabra clave, y los que se dejan en None no se envían. Pasa al menos uno (en caso contrario, 400 NO_UPDATE_DATA).

client.databases.update(database_id, name="orders", ram=2048)

Iniciar y detener

client.databases.start(database_id)
client.databases.stop(database_id)

Al igual que las llamadas del ciclo de vida de las aplicaciones, esperan al menos 120 s, 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(database_id) devuelve valores formateados; raw=True (solo por palabra clave) devuelve números. status_all() devuelve un resumen por base de datos. metrics(database_id) devuelve las últimas 24 horas, un punto cada 5 minutos, del más reciente al más antiguo.

status = client.databases.status(database_id)
print(status["running"], status["cpu"], status["ram"])  # True "0.5%" "120.4MB"

raw = client.databases.status(database_id, raw=True)
print(raw["cpu"], raw["ram"])  # 0.5 120.4

for item in client.databases.status_all():
    print(item["id"], item["running"], item.get("cpu"), item.get("ram"))  # cpu and ram only while running

latest = client.databases.metrics(database_id)[0]
print(latest["date"], latest["cpu"], latest["ram"])

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

Credenciales

certificate(database_id) devuelve el certificado TLS como PEM codificado en base64. reset_credentials(database_id, type) rota la contraseña (y devuelve la nueva) o el certificado (y devuelve ''). La base de datos debe estar en ejecución (400 DATABASE_NOT_RUNNING).

import base64

certificate = client.databases.certificate(database_id)
pem = base64.b64decode(certificate).decode()

password = client.databases.reset_credentials(database_id, "password")
client.databases.reset_credentials(database_id, "certificate")  # ''

Eliminar una base de datos

client.databases.delete(database_id)

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

Snapshots

client.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 Python: 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