Stops a migration from getting poppped.
Stop-Migration [[-Message] <String>] [<CommonParameters>]
The Stop-Migration
operation stops a migration from getting popped. When put in your migration's Pop-Migration
function, the migration will fail when someone attempts to pop it. Use this operation to mark a migration as irreversible.
Stop-Migration
was added in Rivet 0.6.
Name | Type | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|---|
Message | String | A message to show that explains why the migrations isn't reversible. Default message is |
false | false | This migration is irreversible and can't be popped. |
Stop-Migration
Demonstrates how to use use Stop-Migration
.
Stop-Migration -Message 'The datatabase's flibbers have been upgraed to flobbers. This operation can't be undone. Sorry.'
Demonstrates how to display a message explaining why the migration isn't reversible.