Struct sqlx_core::migrate::Migrator

pub struct Migrator {
    pub migrations: Cow<'static, [Migration]>,
    pub ignore_missing: bool,
}

Fields

migrations: Cow<'static, [Migration]>

ignore_missing: bool

Implementations

impl Migrator

pub async fn new<'s, S>(source: S) -> Result<Self, 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) -> &Self

Specify should ignore applied migrations that missing in the resolved migrations.

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

Get an iterator over all known migrations.

pub async fn run<'a, A>(&self, migrator: A) -> Result<(), MigrateError> where
    A: Acquire<'a>,
    <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

let m = Migrator::new(std::path::Path::new("./migrations")).await?;
let pool = sqlx_core::sqlite::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::Connection as Deref>::Target: Migrate, 

Run down migrations against the database until a specific version.

Examples

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

Trait Implementations

impl Debug for Migrator

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

Formats the value using the given formatter.