Skip to main content
api.databases verwaltet die Managed Databases von Square Cloud (MongoDB, MySQL, PostgreSQL und Redis). Jede Methode außer create und statusAll nimmt zuerst die Datenbank-ID. Um deine Datenbanken aufzulisten, verwende api.account.me(): Sein Array databases enthält jede Datenbank, die der Schlüssel sehen kann. Datenbank-Hosting erfordert einen Standard-, Pro- oder Enterprise-Plan. Die Beispiele verwenden den Client api aus Client erstellen. databaseId ist die ID einer deiner Datenbanken: api.account.me() listet sie auf.

Eine Datenbank erstellen

password und certificate werden nur von create() (und von resetCredentials()) zurückgegeben. Der Aufruf wartet mindestens 120 s, bevor ein Timeout eintritt.

Eine Datenbank abrufen

Eine Datenbank aktualisieren

update(databaseId, { name, ram }) benennt eine Datenbank um oder ändert ihre Größe. Übergib mindestens ein Feld (sonst 400 NO_UPDATE_DATA).

Starten und Stoppen

Wie die Lebenszyklus-Aufrufe von Apps warten sie mindestens 120 s, 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(databaseId) gibt formatierte Werte zurück; { raw: true } gibt Zahlen zurück. statusAll() gibt eine Zusammenfassung pro Datenbank zurück. metrics(databaseId) gibt die letzten 24 Stunden zurück, einen Punkt alle 5 Minuten, der neueste zuerst.
Die Statusfelder sind dieselben wie beim App-Status.

Zugangsdaten

certificate(databaseId) gibt das TLS-Zertifikat als Base64-kodiertes PEM zurück. resetCredentials(databaseId, type) erneuert das Passwort (und gibt das neue zurück) oder das Zertifikat (und gibt "" zurück). Die Datenbank muss laufen (400 DATABASE_NOT_RUNNING).

Eine Datenbank löschen

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

Snapshots

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