SDK Python: database gestiti

client.databases gestisce i database gestiti di Square Cloud (MongoDB, MySQL, PostgreSQL e Redis). Ogni metodo tranne create e status_all accetta come primo argomento l’id del database. Per elencare i tuoi database, usa client.account.me(): la sua lista databases contiene ogni database che la chiave può vedere. L’hosting di database richiede un piano Standard, Pro o Enterprise. Gli esempi usano il client di Creare il client. database_id è l’id di uno dei tuoi database: client.account.me() li elenca.

Creare un database

databases.create(name, type=, version=, memory=) accetta il nome per posizione e gli altri campi come argomenti solo keyword.

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	Descrizione
`name`	Da 1 a 32 caratteri
`type`	`mongo`, `mysql`, `redis` o `postgres`
`version`	Una versione completa o un prefisso come `"8"`
`memory`	MB, un `int`. Almeno 512 per Redis e 1024 per gli altri

La password e il certificate vengono restituiti solo da create() (e da reset_credentials()). La chiamata attende almeno 120 s prima di andare in timeout.

Status	Codice	Quando
400	`INVALID_NAME`	Il nome non è compreso tra 1 e 32 caratteri
400	`INVALID_DATABASE_TYPE`, `INVALID_DATABASE_VERSION`	Tipo sconosciuto o versione non supportata
400	`INVALID_MEMORY`	`memory` non è un `int` (un `float` o una stringa)
400	`INSUFFICIENT_MEMORY`	`memory` è sotto il minimo o supera la memoria disponibile
400	`CLUSTER_SELECTION_FAILED`	Nessun cluster aveva capacità sufficiente
400 / 500	`DATABASE_CREATION_FAILED`	Il provisioning è fallito
403	`UPGRADE_REQUIRED`	Il piano non include l’hosting di database
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Il provisioning è sospeso per manutenzione

Recuperare un database

db = client.databases.get(database_id)

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

Aggiornare un database

update(database_id, name=None, ram=None) rinomina o ridimensiona un database. Entrambi gli argomenti sono solo keyword, e quelli lasciati a None non vengono inviati. Passane almeno uno (altrimenti 400 NO_UPDATE_DATA).

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

Avvio e arresto

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

Come le chiamate del ciclo di vita delle app, attendono almeno 120 s, e un rifiuto è un 409 con un codice e un messaggio vuoto: CONTAINER_ALREADY_STARTED, CONTAINER_ALREADY_STOPPED, CONTAINER_NOT_FOUND, CONTAINER_INSUFFICIENT_DISK_SPACE, CONTAINER_NETWORK_CONFLICT o ACTION_FAILED. Mentre è in corso il ripristino di uno snapshot, producono 403 RESTORE_IN_PROGRESS.

Stato e metriche

status(database_id) restituisce valori formattati; raw=True (solo keyword) restituisce numeri. status_all() restituisce un riepilogo per ogni database. metrics(database_id) restituisce le ultime 24 ore, un punto ogni 5 minuti, dal più recente.

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"])

I campi dello stato sono gli stessi dello stato delle app.

Credenziali

certificate(database_id) restituisce il certificato TLS come PEM codificato in base64. reset_credentials(database_id, type) rigenera la password (e restituisce quella nuova) o il certificato (e restituisce ''). Il database deve essere in esecuzione (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")  # ''

Eliminare un database

client.databases.delete(database_id)

L’eliminazione è permanente. Crea prima uno snapshot se potresti avere di nuovo bisogno dei dati.

Snapshot

client.databases.snapshots ha gli stessi list, create e restore delle app. Vedi Snapshot.

Prossimi passi

Workspace

Condividi le app con il tuo team.

Riferimento API dei database

Gli endpoint REST dietro questi metodi.

Database dalla CLI

Le stesse azioni dal terminale.

CLI

VS Code

SDKs

SDK Python: database gestiti

Creare un database

Recuperare un database

Aggiornare un database

Avvio e arresto

Stato e metriche

Credenziali

Eliminare un database

Snapshot

Prossimi passi

Workspace

Riferimento API dei database

Database dalla CLI

​Creare un database

​Recuperare un database

​Aggiornare un database

​Avvio e arresto

​Stato e metriche

​Credenziali

​Eliminare un database

​Snapshot

​Prossimi passi

Workspace

Riferimento API dei database

Database dalla CLI

Creare un database

Recuperare un database

Aggiornare un database

Avvio e arresto

Stato e metriche

Credenziali

Eliminare un database

Snapshot

Prossimi passi