Que fait Aide aux Migrations de Base de Données ?
Cette compétence vous aide à créer des fichiers de migration de base de données qui suivent les conventions et les modèles de nommage de votre projet.
Quand Utiliser Cette Compétence
- L'utilisateur demande la création d'une migration de base de données
- Ajout de nouvelles tables ou colonnes à la base de données
- Modification du schéma de base de données existant
- Création d'index, de contraintes ou de relations
- L'utilisateur mentionne « migration », « changement de schéma » ou « mise à jour de la base de données »
Instructions
1. Détecter l'ORM/Outil de Migration
Identifiez d'abord quel ORM ou outil de migration le projet utilise :
- Prisma : Recherchez
prisma/schema.prismaou@prisma/clientdans package.json - Sequelize : Recherchez
.sequelizercousequelize-clidans package.json - Knex : Recherchez
knexfile.jsouknexdans package.json - TypeORM : Recherchez
ormconfig.jsonoutypeormdans package.json - Alembic (Python) : Recherchez
alembic.iniou le répertoirealembic/ - Django : Recherchez
manage.pyet les migrations Django dans*/migrations/ - Active Record (Rails) : Recherchez le répertoire
db/migrate/ - Flyway : Recherchez
flyway.confoudb/migration/ - Liquibase : Recherchez
liquibase.propertiesou des fichiers changelog
Utilisez Glob pour rechercher ces fichiers indicateurs.
2. Examiner les Migrations Existantes
Lisez les fichiers de migration existants pour comprendre :
- Les conventions de nommage (format du timestamp, format de la description)
- La structure des répertoires
- Le format des fichiers de migration (SQL, JavaScript, TypeScript, Python, etc.)
- Les modèles de codage (fonctions up/down, forward/rollback, etc.)
Utilisez Grep pour trouver les migrations récentes : regardez dans les répertoires courants comme :
prisma/migrations/db/migrate/migrations/oudatabase/migrations/alembic/versions/
3. Générer le Fichier de Migration
En fonction de l'ORM détecté, créez un fichier de migration approprié :
Prisma
- Exécutez
npx prisma migrate dev --name <description>OU - Créez manuellement le SQL de migration dans
prisma/migrations/<timestamp>_<name>/migration.sql
Sequelize
- Générez :
npx sequelize-cli migration:generate --name <description> - Remplissez ensuite les fonctions up/down avec les modifications de schéma
Knex
- Générez :
npx knex migrate:make <description> - Remplissez les fonctions exports.up et exports.down
TypeORM
- Générez :
npm run typeorm migration:create src/migrations/<Nom> - Implémentez les méthodes up() et down()
Alembic
- Générez :
alembic revision -m "<description>" - Remplissez les fonctions upgrade() et downgrade()
Django
- Exécutez :
python manage.py makemigrations - Ou créez manuellement la migration dans
<app>/migrations/
Rails
- Générez :
rails generate migration <NomDeClasse> - Remplissez la méthode change (ou up/down pour les migrations complexes)
4. Suivre les Conventions de Nommage
Utilisez des noms cohérents et descriptifs :
- Bien :
add_user_email_index,create_products_table,add_payment_status_to_orders - Mal :
migration1,update,fix
Formatez selon les modèles du projet :
- Préfixe temporel :
20231215120000_add_email_to_users - Séquentiel :
001_create_users,002_add_indexes
5. Inclure les Opérations Montée et Descente/Rollback
Fournissez toujours les deux directions lorsque c'est possible :
- Up/Upgrade/Forward : Appliquez la modification de schéma
- Down/Downgrade/Rollback : Annulez la modification de schéma
Pour les ORM qui utilisent des opérations réversibles (Rails, certains Sequelize), une seule méthode change peut suffire.
6. Directives pour le Contenu de la Migration
Création de Tables :
- Définissez toutes les colonnes avec des types appropriés
- Définissez les contraintes NOT NULL là où c'est approprié
- Ajoutez des clés primaires
- Incluez les timestamps (created_at, updated_at) si le projet les utilise
- Ajoutez les clés étrangères et les index dans la même migration ou séparément selon les préférences du projet
Modification de Tables :
- Soyez précis :
ADD COLUMN,DROP COLUMN,MODIFY COLUMN - Gérez les données existantes de manière appropriée (valeurs par défaut, remplissage)
- Tenez compte de la rétrocompatibilité
Ajout d'Index :
- Nommez les index clairement :
idx_users_email,idx_orders_user_id_created_at - Utilisez les types d'index appropriés (B-tree, Hash, GIN, etc.)
- Envisagez des index partiels pour les grandes tables
Migrations de Données :
- Séparez les migrations de schéma des migrations de données si possible
- Soyez prudent avec les grands ensembles de données (opérations par lots)
- Testez le rollback avec des volumes de données réalistes
7. Valider la Sécurité de la Migration
Avant de finaliser, vérifiez :
- Réversibilité : La migration peut-elle être annulée ?
- Perte de données : Des données seront-elles perdues ? Prévenez l'utilisateur !
- Temps d'arrêt : Cela verrouillera-t-il des tables ? Envisagez des migrations en ligne pour les grandes tables
- Dépendances : Y a-t-il des migrations dépendantes qui doivent s'exécuter en premier ?
8. Recommandations de Test
Suggérez à l'utilisateur :
- Exécutez d'abord la migration sur une base de données de développement
- Testez la fonctionnalité de rollback
- Pour la production : testez sur un environnement de staging
- Passez en revue le SQL généré (pour les ORM qui génèrent automatiquement)
Modèles Spécifiques à l'ORM
Consultez les modèles dans le répertoire templates/ :
prisma-migration.sql- Exemple de migration Prismasequelize-migration.js- Exemple de migration Sequelizeknex-migration.js- Exemple de migration Knextypeorm-migration.ts- Exemple de migration TypeORMalembic-migration.py- Exemple de migration Alembicrails-migration.rb- Exemple de migration Rails
Bonnes Pratiques
- Un seul objectif par migration : Ne mélangez pas des modifications sans rapport
- Noms descriptifs : Les noms doivent expliquer ce que fait la migration
- Horodatage : Utilisez le format d'horodatage de l'ORM pour l'ordre
- Idempotent si possible : Sans danger à exécuter plusieurs fois
- Testez les rollbacks : Assurez-vous que le down/rollback fonctionne correctement
- Documentez la logique complexe : Ajoutez des commentaires pour les opérations non évidentes
- Traitez les grandes opérations par lots : Pour les migrations de données affectant de nombreuses lignes
- Utilisez des transactions : Enveloppez les opérations dans des transactions lorsque c'est possible
Fichiers d'Accompagnement
templates/: Modèles de migration pour divers ORMreference.md: Conventions de nommage et modèles de migration