SDK JavaScript: database gestiti

api.databases gestisce i database gestiti di Square Cloud (MongoDB, MySQL, PostgreSQL e Redis). Ogni metodo tranne create e statusAll accetta come primo argomento l’id del database. Per elencare i tuoi database, usa api.account.me(): il suo array 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 api di Creare il client. databaseId è l’id di uno dei tuoi database: api.account.me() li elenca.

Creare un database

const db = await api.databases.create({
    name: "my-db",
    type: "postgres", // "mongo" | "mysql" | "redis" | "postgres"
    version: "17",    // a full version or a prefix
    memory: 1024,     // MB, a whole number
});

console.log(db.id, db.connection_url, db.cluster);
console.log(db.password);    // shown only here: save it
console.log(db.certificate); // base64 PEM (private key, then certificate), or null

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 numero intero. Almeno 512 per Redis e 1024 per gli altri

La password e il certificate vengono restituiti solo da create() (e da resetCredentials()). 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 numero intero (un numero frazionario o una stringa)
400	`INSUFFICIENT_MEMORY`	`memory` è sotto il minimo del motore 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

const db = await api.databases.get(databaseId);

console.log(db.id, db.name, db.type, db.ram, db.port, db.cluster, db.created_at);

Aggiornare un database

update(databaseId, { name, ram }) rinomina o ridimensiona un database. Passa almeno un campo (altrimenti 400 NO_UPDATE_DATA).

await api.databases.update(databaseId, { name: "orders", ram: 2048 });

Avvio e arresto

await api.databases.start(databaseId);
await api.databases.stop(databaseId);

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(databaseId) restituisce valori formattati; { raw: true } restituisce numeri. statusAll() restituisce un riepilogo per ogni database. metrics(databaseId) restituisce le ultime 24 ore, un punto ogni 5 minuti, dal più recente.

const status = await api.databases.status(databaseId);
console.log(status.running, status.cpu, status.ram); // true "0.5%" "120.4MB"

const raw = await api.databases.status(databaseId, { raw: true });
console.log(raw.cpu, raw.ram); // 0.5 120.4

for (const { id, running, cpu, ram } of await api.databases.statusAll()) {
    console.log(id, running, cpu, ram); // cpu and ram only while running
}

const [latest] = await api.databases.metrics(databaseId);
console.log(latest.date, latest.cpu, latest.ram);

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

Credenziali

certificate(databaseId) restituisce il certificato TLS come PEM codificato in base64. resetCredentials(databaseId, type) rigenera la password (e restituisce quella nuova) o il certificato (e restituisce ""). Il database deve essere in esecuzione (400 DATABASE_NOT_RUNNING).

const certificate = await api.databases.certificate(databaseId);
const pem = atob(certificate);

const password = await api.databases.resetCredentials(databaseId, "password");
await api.databases.resetCredentials(databaseId, "certificate"); // ""

Eliminare un database

await api.databases.delete(databaseId);

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

Snapshot

api.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 JavaScript: 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