Python-SDK: verwaltete Datenbanken

client.databases verwaltet die Managed Databases von Square Cloud (MongoDB, MySQL, PostgreSQL und Redis). Jede Methode außer create und status_all nimmt zuerst die Datenbank-ID. Um deine Datenbanken aufzulisten, verwende client.account.me(): Seine Liste 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 aus Client erstellen. database_id ist die ID einer deiner Datenbanken: client.account.me() listet sie auf.

Eine Datenbank erstellen

databases.create(name, type=, version=, memory=) nimmt den Namen als Positionsargument und die übrigen Felder als reine Keyword-Argumente.

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

Feld	Beschreibung
`name`	1 bis 32 Zeichen
`type`	`mongo`, `mysql`, `redis` oder `postgres`
`version`	Eine vollständige Version oder ein Präfix wie `"8"`
`memory`	MB, ein `int`. Mindestens 512 für Redis und 1024 für die anderen

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

Status	Code	Wann
400	`INVALID_NAME`	Der Name hat nicht 1 bis 32 Zeichen
400	`INVALID_DATABASE_TYPE`, `INVALID_DATABASE_VERSION`	Unbekannter Typ oder nicht unterstützte Version
400	`INVALID_MEMORY`	`memory` ist kein `int` (ein `float` oder ein String)
400	`INSUFFICIENT_MEMORY`	`memory` liegt unter dem Minimum oder übersteigt den verfügbaren Arbeitsspeicher
400	`CLUSTER_SELECTION_FAILED`	Kein Cluster hatte genug Kapazität
400 / 500	`DATABASE_CREATION_FAILED`	Die Bereitstellung ist fehlgeschlagen
403	`UPGRADE_REQUIRED`	Der Plan enthält kein Datenbank-Hosting
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Die Bereitstellung ist wegen Wartung pausiert

Eine Datenbank abrufen

db = client.databases.get(database_id)

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

Eine Datenbank aktualisieren

update(database_id, name=None, ram=None) benennt eine Datenbank um oder ändert ihre Größe. Beide Argumente sind reine Keyword-Argumente, und die auf None belassenen werden nicht gesendet. Übergib mindestens eines (sonst 400 NO_UPDATE_DATA).

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

Starten und Stoppen

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

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(database_id) gibt formatierte Werte zurück; raw=True (reines Keyword-Argument) gibt Zahlen zurück. status_all() gibt eine Zusammenfassung pro Datenbank zurück. metrics(database_id) gibt die letzten 24 Stunden zurück, einen Punkt alle 5 Minuten, der neueste zuerst.

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

Die Statusfelder sind dieselben wie beim App-Status.

Zugangsdaten

certificate(database_id) gibt das TLS-Zertifikat als Base64-kodiertes PEM zurück. reset_credentials(database_id, 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).

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")  # ''

Eine Datenbank löschen

client.databases.delete(database_id)

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

Snapshots

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

CLI

VS Code

SDKs

Python-SDK: verwaltete Datenbanken

Eine Datenbank erstellen

Eine Datenbank abrufen

Eine Datenbank aktualisieren

Starten und Stoppen

Status und Metriken

Zugangsdaten

Eine Datenbank löschen

Snapshots

Nächste Schritte

Workspaces

API-Referenz für Datenbanken

Datenbanken über die CLI

​Eine Datenbank erstellen

​Eine Datenbank abrufen

​Eine Datenbank aktualisieren

​Starten und Stoppen

​Status und Metriken

​Zugangsdaten

​Eine Datenbank löschen

​Snapshots

​Nächste Schritte

Workspaces

API-Referenz für Datenbanken

Datenbanken über die CLI

Eine Datenbank erstellen

Eine Datenbank abrufen

Eine Datenbank aktualisieren

Starten und Stoppen

Status und Metriken

Zugangsdaten

Eine Datenbank löschen

Snapshots

Nächste Schritte