Struct MigrationRunner 

pub struct MigrationRunner { /* private fields */ }

Runs schema migrations against a SQLite database.

MigrationRunner tracks which migrations have been applied in a schema_versions table and only executes those that have not yet been applied. Migrations are executed in version order inside transactions.

Thread safety

The runner is safe to use from multiple tasks. Concurrent calls to run_pending are safe because each migration runs inside a BEGIN EXCLUSIVE transaction, which serializes access at the database level.

Implementations

impl MigrationRunner

pub fn new(pool: Pool<Sqlite>) -> MigrationRunner

Creates a new runner with the built-in migrations.

pub const fn with_migrations( pool: Pool<Sqlite>, migrations: &'static [Migration], ) -> MigrationRunner

Creates a new runner with a custom set of migrations.

This is primarily useful for testing. In production, prefer new.

pub async fn current_version(&self) -> Result<u32, Error>

Returns the highest migration version that has been applied, or 0 if no migrations have been applied yet.

Errors

Returns an error if the database cannot be queried.

pub async fn pending_migrations(&self) -> Result<Vec<&Migration>, Error>

Returns the list of migrations that have not yet been applied.

Errors

Returns an error if the current version cannot be determined.

pub async fn run_pending(&self) -> Result<Vec<u32>, Error>

Applies all pending migrations in version order.

Each migration runs inside its own transaction. If a migration fails, the transaction is rolled back and the error is returned; previously applied migrations in this call remain committed.

Returns the list of version numbers that were applied.

Errors

Returns an error if any migration fails to apply.

Trait Implementations

impl Clone for MigrationRunner

fn clone(&self) -> MigrationRunner

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MigrationRunner

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.