database.migrate
Markdownv0.3.0
Appliquer une migration de schéma sur la base d'un projet.
- API
POST /v1/projects/{projectId}/database/migrations - MCP
database_migrate - CLI
bastide database migrate
Exécutée d'abord sur une base fantôme — une répétition sur la base réelle, annulée : durée et verrous sont mesurés avant que la migration la touche. dryRun s'arrête là. Un effet destructif est refusé : database_sql_write le fait confirmer.
| Propriété | Valeur |
|---|---|
| Niveau | project |
| Rang minimal | maintainer |
| Rôle transversal | — |
| Portées | db:write |
| Compte de service | ne la mène pas : cette écriture ne lui est pas ouverte |
| Réversibilité | E — réversible avec effort : validation d'une personne avant l'appel, puis cinq minutes pour tout défaire d'un seul appel |
| Idempotence | une clé d'idempotence est acceptée : le rejeu rend la première réponse |
| Limites de débit, par jeton | 600 appels par 60 secondes (general), et 60 appels par 60 secondes (sensitive) |
API
POST /v1/projects/{projectId}/database/migrations — succès en 200.
| Paramètre | Où | Type | Requis | Description |
|---|---|---|---|---|
projectId | chemin | texte, motif ^prj_[0-9A-HJKMNP-TV-Z]{26}$ | oui | Identifiant de projet |
Idempotency-Key | en-tête | texte, de 8 à 128 caractères | non | Clé d'idempotence. Un rejeu portant la même clé retourne le résultat initial sans nouvel effet de bord, et la réponse porte alors « Idempotency-Replayed: true ». Équivaut au champ « idempotencyKey » du corps ; les deux à la fois ne sont acceptés que s'ils sont identiques. |
sql | corps | texte, de 1 à 1000000 caractères | oui | |
dryRun | corps | booléen | non | |
idempotencyKey | corps | texte, de 8 à 128 caractères | non | Clé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord. |
La réponse :
| Champ | Type | Description |
|---|---|---|
applied | booléen | |
durationMs | nombre | |
locksAcquired | objet (untrusted, source, content) | |
rollbackSql | objet (untrusted, source, content), ou nul | Migration inverse, quand elle est dérivable ; elle détruit ce que la migration a créé, et se joue par database_sql_write |
undoToken | nul | Aucun jeton pour cet appel, et null est la vérité : cette opération ne se défait pas par action.undo. |
En-têtes de la réponse : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, RateLimit-Policy, Idempotency-Replayed.
Autres réponses : 400, 401, 403, 404, 409, 429, 500, 503 — communes à toute opération.
Ligne de commande
bastide database migrate --project-id <valeur> --sql <valeur>
| Option | Type | Requise | Défaut | Description |
|---|---|---|---|---|
--project-id | texte | oui | — | Identifiant de projet |
--sql | texte | oui | — | |
--dry-run | booléen | non | false | |
--idempotency-key | texte | non | — | Clé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord. |
La commande demande une confirmation avant d'agir, sauf avec « --yes ».
MCP
Outil database_migrate.
| Propriété | Valeur |
|---|---|
| Lecture seule | non |
| Destructif | oui |
| Idempotent | oui |
| Monde ouvert | non |
| Confirmation en deux temps | non |
| Budget de jetons du résultat | 1200 |
Erreurs
| Code | Surface | Cause |
|---|---|---|
migration_destructive | les deux | La migration, jouée puis annulée, supprime ou vide une table, ou retire une colonne : un effet destructif ne passe pas par une migration. |
migration_refusee_par_la_base | les deux | La base du projet a refusé l'une des instructions de la migration ; rien n'a été appliqué. Le détail nomme l'instruction et son état SQL, jamais le message de la base. |
backend_indisponible | les deux | La base de données du projet n'est pas joignable par la plateforme ; le message nomme la cause. |
idempotency_key_conflict | API | Deux clés d'idempotence différentes ont été présentées, dans le corps et dans l'en-tête. |
S'y ajoutent les refus communs à toute opération — entrée invalide, authentification, autorisation, cible introuvable, conflit, limite de débit, indisponibilité — que le catalogue des erreurs décrit.
Exemples
Éprouver une migration à blanc avant de l'appliquer :
{
"projectId": "prj_01JQ8ZK4M7NP2RSTVWXYZ34567",
"sql": "alter table commandes add column livree_le timestamptz;",
"dryRun": true,
"idempotencyKey": "migration-livree-le-a-blanc-2026-09-14"
}