Struct Migrator

pub struct Migrator { /* private fields */ }

A resolved set of migrations, ready to be run.

Can be constructed statically using migrate!() or at runtime using Migrator::new().

Implementations

impl Migrator

pub async fn new<'s, S>(source: S) -> Result<Migrator, MigrateError>

where S: MigrationSource<'s>,

Creates a new instance with the given source.

Examples

use std::path::Path;

// Read migrations from a local folder: ./migrations
let m = Migrator::new(Path::new("./migrations")).await?;

See MigrationSource for details on structure of the ./migrations directory.

pub fn set_ignore_missing(&mut self, ignore_missing: bool) -> &Migrator

Specify whether applied migrations that are missing from the resolved migrations should be ignored.

pub fn set_locking(&mut self, locking: bool) -> &Migrator

Specify whether or not to lock the database during migration. Defaults to true.

Warning

Disabling locking can lead to errors or data loss if multiple clients attempt to apply migrations simultaneously without some sort of mutual exclusion.

This should only be used if the database does not support locking, e.g. CockroachDB which talks the Postgres protocol but does not support advisory locks used by SQLx’s migrations support for Postgres.

pub fn iter(&self) -> Iter<'_, Migration>

Get an iterator over all known migrations.

pub fn version_exists(&self, version: i64) -> bool

Check if a migration version exists.

pub async fn run<'a, A>(&self, migrator: A) -> Result<(), MigrateError>

where A: Acquire<'a>, <<A as Acquire<'a>>::Connection as Deref>::Target: Migrate,

Run any pending migrations against the database; and, validate previously applied migrations against the current migration source to detect accidental changes in previously-applied migrations.

Examples

use sqlx::migrate::Migrator;
use sqlx::sqlite::SqlitePoolOptions;

let m = Migrator::new(std::path::Path::new("./migrations")).await?;
let pool = SqlitePoolOptions::new().connect("sqlite::memory:").await?;
m.run(&pool).await

pub async fn undo<'a, A>( &self, migrator: A, target: i64, ) -> Result<(), MigrateError>

where A: Acquire<'a>, <<A as Acquire<'a>>::Connection as Deref>::Target: Migrate,

Run down migrations against the database until a specific version.

Examples

use sqlx::migrate::Migrator;
use sqlx::sqlite::SqlitePoolOptions;

let m = Migrator::new(std::path::Path::new("./migrations")).await?;
let pool = SqlitePoolOptions::new().connect("sqlite::memory:").await?;
m.undo(&pool, 4).await

Trait Implementations

impl Debug for Migrator

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

Formats the value using the given formatter.