Struct PgMigrationRunner 

pub struct PgMigrationRunner { /* private fields */ }

Runs schema migrations against a PostgreSQL database.

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.

Concurrency safety

Uses LOCK TABLE schema_versions IN EXCLUSIVE MODE within transactions to prevent concurrent migration runners from applying the same migration twice.

Implementations

impl PgMigrationRunner

pub fn new(pool: Pool<Postgres>) -> PgMigrationRunner

Creates a new runner with the built-in migrations.

pub const fn with_migrations( pool: Pool<Postgres>, migrations: &'static [PgMigration], ) -> PgMigrationRunner

Creates a new runner with a custom set of migrations.

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<&PgMigration>, 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 with an exclusive lock on the schema_versions table to prevent concurrent application. If a migration fails, the transaction is rolled back and the error is returned.

Returns the list of version numbers that were applied.

Errors

Returns an error if any migration fails to apply.

Trait Implementations

impl Clone for PgMigrationRunner

fn clone(&self) -> PgMigrationRunner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PgMigrationRunner

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

Formats the value using the given formatter.