Skip to main content
api.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 statusAll, prend d’abord l’identifiant de la base de données. Pour lister vos bases de données, utilisez api.account.me() : son tableau 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 api présenté dans Créer le client. databaseId est l’identifiant de l’une de vos bases de données : api.account.me() les liste.

Créer une base de données

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

Récupérer une base de données

Mettre à jour une base de données

update(databaseId, { name, ram }) renomme ou redimensionne une base de données. Passez au moins un champ (400 NO_UPDATE_DATA sinon).

Démarrer et arrêter

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(databaseId) renvoie des valeurs formatées ; { raw: true } renvoie des nombres. statusAll() renvoie un résumé par base de données. metrics(databaseId) renvoie les dernières 24 heures, un point toutes les 5 minutes, du plus récent au plus ancien.
Les champs de statut sont les mêmes que pour le statut des applications.

Identifiants

certificate(databaseId) renvoie le certificat TLS en PEM encodé en base64. resetCredentials(databaseId, 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).

Supprimer une base de données

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

Snapshots

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