MigrationSequence

A complete sequence of migrations that can be applied to transform data.

A migration sequence represents a series of ordered migrations that belong together, typically for a specific part of your schema. The sequence includes metadata about whether it should be applied retroactively to existing data and contains the actual migration definitions in execution order.

interface MigrationSequence {}

Properties

retroactive should be true if the migrations should be applied to snapshots that were created before this migration sequence was added to the schema.

In general:

• retroactive should be true when app developers create their own new migration sequences.
• retroactive should be false when library developers ship a migration sequence. When you install a library for the first time, any migrations that were added in the library before that point should generally not be applied to your existing data.

retroactive: boolean

sequence: Migration[]

sequenceId: string