SqliteMigrationService class

High-level SQLite migration orchestration service.

Constructors

SqliteMigrationService({SqliteMigrationPlanner planner = const SqliteMigrationPlanner(), SqliteMigrationRunner runner = const SqliteMigrationRunner()})

Creates a SQLite migration service.

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

planner → SqliteMigrationPlanner

Planner used to create migration plans.

final

runner → SqliteMigrationRunner

Runner used to apply, rollback, and inspect migrations.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

applySchema({required Database database, required SchemaDocument target, required String migrationName, bool allowWarnings = false}) → SqliteMigrationResult

Applies target to the database and records the migration result.

deployMigrations({required Database database, required String migrationsDirectory}) → DeployResult

Applies all pending local migrations in order.

draftFromDatabase({required Database database, required SchemaDocument target, required String migrationName}) → SqliteMigrationDraft

Creates a migration draft by diffing the live database against target.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pushSchema({required Database database, required SchemaDocument target, bool allowWarnings = false}) → SqliteMigrationResult

Applies target directly without writing migration history.

resolveApplied({required Database database, required String migrationsDirectory, required String migrationName}) → ResolveResult

Marks a local migration as already applied without executing SQL.

resolveRolledBack({required Database database, required String migrationName}) → ResolveResult

Marks an active migration as rolled back without executing SQL.

rollbackMigration({required Database database, required String migrationsDirectory, String? migrationName, String? rollbackName, bool allowWarnings = false}) → SqliteRollbackResult

Rolls back a migration using stored or on-disk schema snapshots.

status({required Database database, required String migrationsDirectory}) → SqliteMigrationStatus

Compares database history with local migration artifacts.

toString() → String

A string representation of this object.

inherited

writeDraft({required SqliteMigrationDraft draft, required String directoryPath}) → Directory

Writes a draft to a migration directory on disk.

Operators

operator ==(Object other) → bool

The equality operator.

inherited