Datenbank-Migrationshelfer
Dieses Skill hilft Ihnen, Datenbank-Migrationsdateien zu erstellen, die den ORM-Konventionen und Namensmustern Ihres Projekts folgen.
Wann dieses Skill verwendet werden sollte
- Benutzer fordert die Erstellung einer Datenbankmigration an
- Hinzufügen neuer Tabellen oder Spalten zur Datenbank
- Ändern eines bestehenden Datenbankschemas
- Erstellen von Indizes, Constraints oder Beziehungen
- Benutzer erwähnt „Migration“, „Schemaänderung“ oder „Datenbankupdate“
Anleitung
1. ORM/Migrationstool erkennen
Identifizieren Sie zunächst, welches ORM oder Migrationstool das Projekt verwendet:
- Prisma: Suchen Sie nach
prisma/schema.prismaoder@prisma/clientin package.json - Sequelize: Suchen Sie nach
.sequelizercodersequelize-cliin package.json - Knex: Suchen Sie nach
knexfile.jsoderknexin package.json - TypeORM: Suchen Sie nach
ormconfig.jsonodertypeormin package.json - Alembic (Python): Suchen Sie nach
alembic.inioder demalembic/-Verzeichnis - Django: Suchen Sie nach
manage.pyund Django-Migrationen in*/migrations/ - Active Record (Rails): Suchen Sie nach dem
db/migrate/-Verzeichnis - Flyway: Suchen Sie nach
flyway.confoderdb/migration/ - Liquibase: Suchen Sie nach
liquibase.propertiesoder Changelog-Dateien
Verwenden Sie Glob, um nach diesen Indikatordateien zu suchen.
2. Vorhandene Migrationen untersuchen
Lesen Sie vorhandene Migrationsdateien, um Folgendes zu verstehen:
- Namenskonventionen (Zeitstempelformat, Beschreibungsformat)
- Verzeichnisstruktur
- Migrationsdateiformat (SQL, JavaScript, TypeScript, Python usw.)
- Codierungsmuster (up/down-Funktionen, forwards/rollback usw.)
Verwenden Sie Grep, um aktuelle Migrationen zu finden: Suchen Sie in gängigen Verzeichnissen wie:
prisma/migrations/db/migrate/migrations/oderdatabase/migrations/alembic/versions/
3. Migrationsdatei generieren
Erstellen Sie basierend auf dem erkannten ORM eine entsprechende Migrationsdatei:
Prisma
- Führen Sie
npx prisma migrate dev --name <beschreibung>aus ODER - Erstellen Sie manuell eine Migrations-SQL-Datei unter
prisma/migrations/<zeitstempel>_<name>/migration.sql
Sequelize
- Generieren:
npx sequelize-cli migration:generate --name <beschreibung> - Füllen Sie dann die up/down-Funktionen mit den Schemaänderungen aus
Knex
- Generieren:
npx knex migrate:make <beschreibung> - Füllen Sie die exports.up- und exports.down-Funktionen aus
TypeORM
- Generieren:
npm run typeorm migration:create src/migrations/<Name> - Implementieren Sie die Methoden up() und down()
Alembic
- Generieren:
alembic revision -m "<beschreibung>" - Füllen Sie die Funktionen upgrade() und downgrade() aus
Django
- Führen Sie aus:
python manage.py makemigrations - Oder erstellen Sie manuell eine Migration in
<app>/migrations/
Rails
- Generieren:
rails generate migration <Klassenname> - Füllen Sie die change-Methode aus (oder up/down für komplexe Migrationen)
4. Namenskonventionen einhalten
Verwenden Sie konsistente, beschreibende Namen:
- Gut:
add_user_email_index,create_products_table,add_payment_status_to_orders - Schlecht:
migration1,update,fix
Format basierend auf Projektmustern:
- Zeitstempel-Präfix:
20231215120000_add_email_to_users - Sequentiell:
001_create_users,002_add_indexes
5. Sowohl Up als auch Down/Rollback einfügen
Geben Sie immer beide Richtungen an, wenn unterstützt:
- Up/Upgrade/Forward: Schemaänderung anwenden
- Down/Downgrade/Rollback: Schemaänderung rückgängig machen
Für ORMs, die reversible Operationen verwenden (Rails, manche Sequelize), kann eine einzelne change-Methode ausreichen.
6. Richtlinien zum Migrationsinhalt
Tabellen erstellen:
- Definieren Sie alle Spalten mit geeigneten Typen
- Setzen Sie NOT NULL-Constraints wo angemessen
- Fügen Sie Primärschlüssel hinzu
- Fügen Sie Zeitstempel (created_at, updated_at) hinzu, wenn das Projekt sie verwendet
- Fügen Sie Fremdschlüssel und Indizes in derselben Migration oder separat hinzu, je nach Projektpräferenz
Tabellen ändern:
- Seien Sie spezifisch:
ADD COLUMN,DROP COLUMN,MODIFY COLUMN - Behandeln Sie vorhandene Daten angemessen (Defaults, Backfills)
- Berücksichtigen Sie Rückwärtskompatibilität
Indizes hinzufügen:
- Benennen Sie Indizes klar:
idx_users_email,idx_orders_user_id_created_at - Verwenden Sie geeignete Indextypen (B-Baum, Hash, GIN usw.)
- Erwägen Sie partielle Indizes für große Tabellen
Datenmigrationen:
- Trennen Sie Schema-Migrationen nach Möglichkeit von Datenmigrationen
- Seien Sie vorsichtig bei großen Datensätzen (Batch-Operationen)
- Testen Sie den Rollback mit realistischen Datenmengen
7. Migrationssicherheit validieren
Überprüfen Sie vor dem Abschluss:
- Umkehrbarkeit: Kann die Migration rückgängig gemacht werden?
- Datenverlust: Gehen Daten verloren? Warnen Sie den Benutzer!
- Ausfallzeit: Werden Tabellen gesperrt? Erwägen Sie Online-Migrationen für große Tabellen
- Abhängigkeiten: Gibt es abhängige Migrationen, die zuerst ausgeführt werden müssen?
8. Testempfehlungen
Schlagen Sie dem Benutzer vor:
- Migration zuerst in einer Entwicklungsdatenbank ausführen
- Rollback-Funktionalität testen
- Für die Produktion: In einer Staging-Umgebung testen
- Generiertes SQL überprüfen (für ORMs, die automatisch generieren)
ORM-spezifische Vorlagen
Beziehen Sie sich auf die Vorlagen im templates/-Verzeichnis:
prisma-migration.sql- Prisma-Migrationsbeispielsequelize-migration.js- Sequelize-Migrationsbeispielknex-migration.js- Knex-Migrationsbeispieltypeorm-migration.ts- TypeORM-Migrationsbeispielalembic-migration.py- Alembic-Migrationsbeispielrails-migration.rb- Rails-Migrationsbeispiel
Best Practices
- Ein Zweck pro Migration: Mischen Sie keine zusammenhanglosen Änderungen
- Beschreibende Namen: Namen sollten erklären, was die Migration tut
- Zeitstempel: Verwenden Sie das Zeitstempelformat des ORMs für die Reihenfolge
- Nach Möglichkeit idempotent: Sollte sicher mehrmals ausgeführt werden können
- Rollbacks testen: Stellen Sie sicher, dass down/rollback korrekt funktioniert
- Komplexe Logik dokumentieren: Fügen Sie Kommentare für nicht offensichtliche Operationen hinzu
- Große Operationen bündeln: Für Datenmigrationen, die viele Zeilen betreffen
- Transaktionen verwenden: Wickeln Sie Operationen nach Möglichkeit in Transaktionen ein
Unterstützende Dateien
templates/: Migrationsvorlagen für verschiedene ORMsreference.md: Namenskonventionen und Migrationsmuster