Callback Events

Flyway offers you the possibility to hook into its lifecycle by using Callbacks.

For more information see Callbacks.

Note: Callbacks are partially supported by Native Connectors.

List of events

<table class="table table-hover"> <thead> <tr> <th><strong>Migrate</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeMigrate"> <td>beforeMigrate</td> <td>Before Migrate runs</td> </tr> <tr id="beforeRepeatables"> <td>beforeRepeatables</td> <td>Before all repeatable migrations during Migrate</td> </tr> <tr id="beforeEachMigrate"> <td>beforeEachMigrate</td> <td>Before every single migration during Migrate</td> </tr> <tr id="beforeEachMigrateStatement"> <td>beforeEachMigrateStatement</td> <td>Before every single statement of a migration during Migrate</td> </tr> <tr id="afterEachMigrateStatement"> <td>afterEachMigrateStatement</td> <td>After every single successful statement of a migration during Migrate</td> </tr> <tr id="afterEachMigrateStatementError"> <td>afterEachMigrateStatementError</td> <td>After every single failed statement of a migration during Migrate</td> </tr> <tr id="afterEachMigrate"> <td>afterEachMigrate</td> <td>After every single successful migration during Migrate</td> </tr> <tr id="afterEachMigrateError"> <td>afterEachMigrateError</td> <td>After every single failed migration during Migrate</td> </tr> <tr id="afterMigrate"> <td>afterMigrate</td> <td>After Migrate command succeeds</td> </tr> <tr id="afterMigrateApplied"> <td>afterMigrateApplied</td> <td>After Migrate command succeeds where at least one migration has been applied</td> </tr> <tr id="afterVersioned"> <td>afterVersioned</td> <td>After all versioned migrations during Migrate</td> </tr> <tr id="afterMigrateError"> <td>afterMigrateError</td> <td>After Migrate command fails</td> </tr> </tbody> </table> <table class="table table-hover"> <thead> <tr> <th><strong>Undo</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeUndo"> <td>beforeUndo {% include teams.html %}</td> <td>Before Undo runs</td> </tr> <tr id="beforeEachUndo"> <td>beforeEachUndo {% include teams.html %}</td> <td>Before every single migration during Undo</td> </tr> <tr id="beforeEachUndoStatement"> <td>beforeEachUndoStatement {% include teams.html %}</td> <td>Before every single statement of a migration during Undo</td> </tr> <tr id="afterEachUndoStatement"> <td>afterEachUndoStatement {% include teams.html %}</td> <td>After every single successful statement of a migration during Undo</td> </tr> <tr id="afterEachUndoStatementError"> <td>afterEachUndoStatementError {% include teams.html %}</td> <td>After every single failed statement of a migration during Undo</td> </tr> <tr id="afterEachUndo"> <td>afterEachUndo {% include teams.html %}</td> <td>After every single successful migration during Undo</td> </tr> <tr id="afterEachUndoError"> <td>afterEachUndoError {% include teams.html %}</td> <td>After every single failed migration during Undo</td> </tr> <tr id="afterUndo"> <td>afterUndo {% include teams.html %}</td> <td>After Undo command succeeds</td> </tr> <tr id="afterUndoError"> <td>afterUndoError {% include teams.html %}</td> <td>After Undo command fails</td> </tr> </tbody> </table> <table class="table table-hover"> <thead> <tr> <th><strong>Deploy</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeDeploy"> <td>beforeDeploy</td> <td>Before Deploy runs</td> </tr> <tr id="afterDeploy"> <td>afterDeploy</td> <td>After Deploy command succeeds</td> </tr> <tr id="afterDeployError"> <td>afterDeployError</td> <td>After Deploy command fails</td> </tr> </tbody> </table> <table class="table table-hover"> <thead> <tr> <th><strong>Clean</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeClean"> <td>beforeClean</td> <td>Before Clean runs</td> </tr> <tr id="afterClean"> <td>afterClean</td> <td>After Clean command succeeds</td> </tr> <tr id="afterCleanError"> <td>afterCleanError</td> <td>After Clean command fails</td> </tr> </tbody> </table> <table class="table table-hover"> <thead> <tr> <th><strong>Info</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeInfo"> <td>beforeInfo</td> <td>Before Info runs</td> </tr> <tr id="afterInfo"> <td>afterInfo</td> <td>After Info command succeeds</td> </tr> <tr id="afterInfoError"> <td>afterInfoError</td> <td>After Info command fails</td> </tr> </tbody> </table>

Note: It is strongly discouraged to include any write-related callbacks for the Info command. The Info command may be internally triggered by Flyway.

<table class="table table-hover"> <thead> <tr> <th><strong>Validate</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeValidate"> <td>beforeValidate</td> <td>Before Validate runs</td> </tr> <tr id="afterValidate"> <td>afterValidate</td> <td>After Validate command succeeds</td> </tr> <tr id="afterValidateError"> <td>afterValidateError</td> <td>After Validate command fails</td> </tr> </tbody> </table> <table class="table table-hover"> <thead> <tr> <th><strong>Baseline</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeBaseline"> <td>beforeBaseline</td> <td>Before Baseline runs</td> </tr> <tr id="afterBaseline"> <td>afterBaseline</td> <td>After Baseline command succeeds</td> </tr> <tr id="afterBaselineError"> <td>afterBaselineError</td> <td>After Baseline command fails</td> </tr> </tbody> </table> <table class="table table-hover"> <thead> <tr> <th><strong>Repair</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="beforeRepair"> <td>beforeRepair</td> <td>Before Repair runs</td> </tr> <tr id="afterRepair"> <td>afterRepair</td> <td>After Repair command succeeds</td> </tr> <tr id="afterRepairError"> <td>afterRepairError</td> <td>After Repair command fails</td> </tr> </tbody> </table> <table class="table table-hover"> <thead> <tr> <th><strong>Name</strong></th> <th><strong>Execution</strong></th> </tr> </thead> <tbody> <tr id="createSchema"> <td>createSchema [deprecated, use beforeCreateSchema]</td> <td>Before automatically creating non-existent schemas</td> </tr> <tr id="beforeCreateSchema"> <td>beforeCreateSchema</td> <td>Before automatically creating non-existent schemas</td> </tr> <tr id="beforeConnect"> <td>beforeConnect {% include redgate.html %}</td> <td>Before Flyway connects to the database</td> </tr> <tr id="afterConnect"> <td>afterConnect</td> <td>Immediately after Flyway connects to the database</td> </tr> </tbody> </table>