Illuminate\Database\Events\MigrationFailed. Tritt während der Ausführung einer einzelnen Migration eine Exception auf, löst Laravel dieses Event aus und wirft die Exception anschließend erneut.
Es handelt sich nicht um einen Mechanismus, der Migrationen automatisch erneut ausführt. Das Event dient dazu, den Namen der fehlgeschlagenen Migration, ob up oder down fehlgeschlagen ist, und die ursprüngliche Exception an Logs und Benachrichtigungen weiterzugeben.
Informationen des Events
MigrationFailed erbt von MigrationEvent und stellt für eine einzelne Migration die folgenden Werte bereit.
Wenn Sie zusätzlich zu
name auch migration::class protokollieren, können Sie die Migration auch auf Pfaden identifizieren, auf denen der Dateiname nicht verfügbar ist. Mit migration->getConnection() sehen Sie außerdem den Verbindungsnamen, den die Migration explizit angegeben hat.
Einen Listener registrieren
Registrieren Sie das Event im Service Provider Ihrer Anwendung und übergeben Sie strukturierten Kontext sowie die ursprüngliche Exception an das Log.php artisan migrate und php artisan migrate:rollback weiterhin mit einem Fehler.
Reihenfolge der Events
Bei einer normalen einzelnen Migration löst derMigrator die Events in der folgenden Reihenfolge aus.
MigrationEnded wird nur ausgelöst, wenn die Ausführung erfolgreich ist. Wirft die Verarbeitung der Migration oder ein Listener für ein während der Ausführung ausgelöstes Event eine Exception, gelangt die Ausführung in die Exception-Behandlung von runMigration und MigrationFailed wird ausgelöst.
Wird die Exception mitten in einem Batch erneut geworfen, werden die verbleibenden Migrationen nicht ausgeführt. Daher wird für einen fehlgeschlagenen Batch nicht unbedingt MigrationsEnded ausgelöst. Behandeln Sie den Abschluss eines Batches und den Fehlerfall nicht mit demselben Event.
Zusammenhang mit Transaktionen
Wenn die Schema Grammar der Datenbank Schema-Transaktionen unterstützt undwithinTransaction der Migration aktiviert ist, umschließt Laravel die Ausführung mit einer Transaktion.
MigrationFailed nach dem Rollback der Transaktion ausgelöst. In folgenden Fällen kann die Datenbank jedoch nicht unbedingt alle Operationen zurückrollen:
- Die verwendete Datenbank oder Schema Grammar unterstützt keine Schema-Transaktionen
- Die Migration setzt
public $withinTransaction = false - Die Datenbank behandelt DDL nicht transaktional
migrations, bevor Sie wiederherstellen.
Fehler in up und down unterscheiden
Fehler beim Rollback werden über dasselbe Event gemeldet. Prüfen Sie method, um Benachrichtigungsziele und Betriebsabläufe für das Anwenden und das Zurücknehmen zu trennen.
down fehl, tritt die Exception auf, bevor die Migration aus der Tabelle migrations entfernt wird. Der Migrator entfernt den Eintrag erst, nachdem down erfolgreich abgeschlossen wurde. Prüfen Sie nach einem Fehler daher sowohl das tatsächliche Schema als auch den Eintrag.
Grenzen von Monitoring und Benachrichtigungen
MigrationFailed wird synchron in dem Prozess verarbeitet, der das Deployment oder den manuellen Artisan-Befehl ausgeführt hat. Wenn Sie die Benachrichtigung in eine Queue stellen, können Sie deren Zustellung in die nachgelagerte Verarbeitung auslagern, ohne den Fehler des Migrationsbefehls selbst zu verbergen.
Vermeiden Sie es jedoch, die fehlgeschlagene Migration aus dem Listener erneut auszuführen. Eine erneute Ausführung, bevor derselbe Befehl beendet ist, verkompliziert Sperren, teilweise angewendetes DDL und die Reihenfolge des Deployments. Wenn eine erneute Ausführung nötig ist, beheben Sie die Ursache, prüfen Sie den Zustand und führen Sie sie dann als Betriebsablauf aus.
Das Event in Tests prüfen
Bereiten Sie eine fehlschlagende Test-Migration vor und prüfen Sie, dass der Artisan-Befehl fehlschlägt und das Event die verursachende Exception enthält. Legen Sie Test-Migrationen nicht dort ab, wo sie in der Produktion gefunden werden.Event::fake zeichnet Events auf, sodass Sie getrennt von der tatsächlichen Benachrichtigungsverarbeitung Ihrer Anwendung testen können. Ob ein Rollback stattfindet und ob kein DDL teilweise zurückbleibt, prüfen Sie in separaten Integrationstests mit Ihrer Datenbank und Schema Grammar.
Zusammenfassung
MigrationFailedübergibt beim Fehlschlagen einer einzelnen Migrationmigration,method,nameundexception.MigrationEndedwird nur bei Erfolg ausgelöst,MigrationsEndednur, wenn der Batch vollständig abgeschlossen wurde.- Das Verhalten von Transaktionen und DDL unterscheidet sich je nach Datenbank. Behandeln Sie das Event daher nicht als Garantie für ein Rollback.
- Beschränken Sie Listener auf Monitoring und Benachrichtigungen und führen Sie erneute Ausführungen und Wiederherstellungen erst nach Prüfung von Ursache und Schema als Betriebsablauf durch.