TableMigration class

Contains instructions needed to run a complex migration on a table, using the steps described in Making other kinds of table schema changes.

For examples and more details, see the documentation.

Annotations
  • @experimental

Constructors

TableMigration(TableInfo<Table, dynamic> affectedTable, {Map<GeneratedColumn, Expression> columnTransformer = const {}, List<GeneratedColumn> newColumns = const []})
Creates migration description on the affectedTable.

Properties

affectedTable TableInfo<Table, dynamic>
The table to migrate. It is assumed that this table already exists at the time the migration is running. If you need to create a new table, use Migrator.createTable instead of the more complex TableMigration.
final
columnTransformer Map<GeneratedColumn, Expression>
A map describing how to transform columns of the affectedTable.
final
hashCode int
The hash code for this object.
no setterinherited
newColumns List<GeneratedColumn>
A list of new columns that are known to not exist in the database yet.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited