ClientMigrationManager class

Handles migrations for client-side databases.

Inheritance

Constructors

ClientMigrationManager({required String? runMode, required List<MigrationVersionSql> migrations, required String moduleName})
Creates a manager for the given in-memory migrations and moduleName.

Properties

availableVersions List<String>
List of available migration versions as loaded from the migrations directory. Available after starting a migration or repair migration.
finalinherited
hashCode int
The hash code for this object.
no setterinherited
runMode String?
The run mode of the server.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

applyRepairMigration(DatabaseSession session) Future<String?>
Applies the repair migration to the database.
inherited
listAvailableVersions() Future<List<String>>
Lists all available migration versions.
inherited
loadInstalledRepairMigration(DatabaseSession session, {Transaction? transaction}) Future<DatabaseMigrationVersionModel?>
Loads the installed repair migration from the database.
override
loadInstalledVersions(DatabaseSession session, {Transaction? transaction}) Future<List<DatabaseMigrationVersionModel>>
Loads the installed versions of the migrations from the database.
override
migrateToLatest(DatabaseSession session) Future<List<String>?>
Migrates all modules to the latest version.
inherited
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