Stop-Migration

Stops a migration from getting poppped.

Syntax

Stop-Migration [[-Message] <String>] [<CommonParameters>]

Description

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.

Parameters

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 This migration is irreversible and can't be popped..

false false This migration is irreversible and can't be popped.

EXAMPLE 1

Stop-Migration

Demonstrates how to use use Stop-Migration.

EXAMPLE 2

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.