SDK Python : bases de données gérées

client.databases gère les bases de données gérées de Square Cloud (MongoDB, MySQL, PostgreSQL et Redis). Chaque méthode, sauf create et status_all, prend d’abord l’identifiant de la base de données. Pour lister vos bases de données, utilisez client.account.me() : sa liste databases contient toutes les bases de données que la clé peut voir. L’hébergement de bases de données nécessite un plan Standard, Pro ou Enterprise. Les exemples utilisent le client présenté dans Créer le client. database_id est l’identifiant de l’une de vos bases de données : client.account.me() les liste.

Créer une base de données

databases.create(name, type=, version=, memory=) prend le nom par position et les autres champs comme arguments uniquement nommés (keyword-only).

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

Champ	Description
`name`	De 1 à 32 caractères
`type`	`mongo`, `mysql`, `redis` ou `postgres`
`version`	Une version complète ou un préfixe comme `"8"`
`memory`	Mo, un `int`. Au moins 512 pour Redis et 1024 pour les autres

Le password et le certificate ne sont renvoyés que par create() (et par reset_credentials()). L’appel attend au moins 120 s avant d’expirer.

Statut	Code	Quand
400	`INVALID_NAME`	Le nom ne fait pas de 1 à 32 caractères
400	`INVALID_DATABASE_TYPE`, `INVALID_DATABASE_VERSION`	Type inconnu ou version non prise en charge
400	`INVALID_MEMORY`	`memory` n’est pas un `int` (un `float` ou une chaîne)
400	`INSUFFICIENT_MEMORY`	`memory` est inférieur au minimum ou dépasse la mémoire disponible
400	`CLUSTER_SELECTION_FAILED`	Aucun cluster n’avait assez de capacité
400 / 500	`DATABASE_CREATION_FAILED`	Le provisionnement a échoué
403	`UPGRADE_REQUIRED`	Le plan n’inclut pas l’hébergement de bases de données
503	`CLUSTER_MAINTENANCE_TRY_LATER`	Le provisionnement est suspendu pour maintenance

Récupérer une base de données

db = client.databases.get(database_id)

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

Mettre à jour une base de données

update(database_id, name=None, ram=None) renomme ou redimensionne une base de données. Les deux arguments sont uniquement nommés, et ceux laissés à None ne sont pas envoyés. Passez-en au moins un (400 NO_UPDATE_DATA sinon).

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

Démarrer et arrêter

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

Comme les appels de cycle de vie des applications, ils attendent au moins 120 s, et un refus donne 409 avec un code et un message vide : CONTAINER_ALREADY_STARTED, CONTAINER_ALREADY_STOPPED, CONTAINER_NOT_FOUND, CONTAINER_INSUFFICIENT_DISK_SPACE, CONTAINER_NETWORK_CONFLICT ou ACTION_FAILED. Pendant la restauration d’un snapshot, ils donnent 403 RESTORE_IN_PROGRESS.

Statut et métriques

status(database_id) renvoie des valeurs formatées ; raw=True (argument uniquement nommé) renvoie des nombres. status_all() renvoie un résumé par base de données. metrics(database_id) renvoie les dernières 24 heures, un point toutes les 5 minutes, du plus récent au plus ancien.

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

Les champs de statut sont les mêmes que pour le statut des applications.

Identifiants

certificate(database_id) renvoie le certificat TLS en PEM encodé en base64. reset_credentials(database_id, type) renouvelle le mot de passe (et renvoie le nouveau) ou le certificat (et renvoie ''). La base de données doit être en cours d’exécution (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")  # ''

Supprimer une base de données

client.databases.delete(database_id)

La suppression est définitive. Prenez d’abord un snapshot si vous risquez d’avoir de nouveau besoin des données.

Snapshots

client.databases.snapshots dispose des mêmes list, create et restore que les applications. Voir Snapshots.

Prochaines étapes

Workspaces

Partagez des applications avec votre équipe.

Référence de l'API des bases de données

Les endpoints REST derrière ces méthodes.

Bases de données depuis la CLI

Les mêmes actions depuis le terminal.

CLI

VS Code

SDKs

SDK Python : bases de données gérées

Créer une base de données

Récupérer une base de données

Mettre à jour une base de données

Démarrer et arrêter

Statut et métriques

Identifiants

Supprimer une base de données

Snapshots

Prochaines étapes

Workspaces

Référence de l'API des bases de données

Bases de données depuis la CLI

​Créer une base de données

​Récupérer une base de données

​Mettre à jour une base de données

​Démarrer et arrêter

​Statut et métriques

​Identifiants

​Supprimer une base de données

​Snapshots

​Prochaines étapes

Workspaces

Référence de l'API des bases de données

Bases de données depuis la CLI

Créer une base de données

Récupérer une base de données

Mettre à jour une base de données

Démarrer et arrêter

Statut et métriques

Identifiants

Supprimer une base de données

Snapshots

Prochaines étapes