Migrator class final

Provides methods for generating SQL statements used to create, alter, or drop elements in a database.

An instance of Migrator is created by drift internally to run the migrations declared with a MigrationStrategy on your database class.

Constructors

Migrator(GeneratedDatabase database, [VersionedSchema? _fixedVersion])

Used internally by drift when opening the database.

Properties

database → GeneratedDatabase

The instance of the GeneratedDatabase class generated by drift_dev that this migrator is connected to.

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addColumn(GeneratedTable<Object, GeneratedTable<Object, dynamic>> table, TableColumn<Object> column) → Future<void>

Adds the given column to the specified table.

create(DatabaseSchemaEntity entity) → Future<void>

Creates the given entity, which can be a table, a view, a trigger, an index or an OnCreateQuery.

createAll() → Future<void>

Creates all tables, triggers, views, indexes and everything else defined in the database, if they don't exist.

createIndex(Index index) → Future<void>

Executes a CREATE INDEX statement to create the index.

createTable(GeneratedTable<Object, GeneratedTable<Object, dynamic>> table) → Future<void>

Creates the given table if it doesn't exist.

createTrigger(Trigger trigger) → Future<void>

Executes the CREATE TRIGGER statement that created the trigger.

createView(GeneratedView<Object, GeneratedView<Object, dynamic>> view) → Future<void>

Creates the given view if it doesn't exist.

deleteTable(String name) → Future<void>

Deletes the table with the given name. Note that this function does not escape the name parameter.

drop(DatabaseSchemaEntity entity) → Future<void>

Drops a table, trigger or index.

dropColumn(GeneratedTable<Object, GeneratedTable<Object, dynamic>> table, String column) → Future<void>

Attempts to alter table to drop the column.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

recreateAllViews() → Future<void>

Drops and re-creates all views known to the database.

renameColumn(GeneratedTable<Object, GeneratedTable<Object, dynamic>> table, String oldName, TableColumn<Object> column) → Future<void>

Changes the name of a column in a table.

renameTable(GeneratedTable<Object, GeneratedTable<Object, dynamic>> table, String oldName) → Future<void>

Changes the table name from oldName to the current GeneratedTable.entityName.

runMigrationSteps({required int from, required int to, required MigrationStepWithVersion steps}) → Future<void>

Allows customizing step-by-step migrations (like the OnUpgrade callback returned by the generated stepByStep function) by invoking the steps function for each intermediate schema version from from until to is reached.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited