Struct Migratex 

pub struct Migratex<'m, 'c, MigContext, M: Metadata> { /* private fields */ }

Migratex manages the migrations, this is the main struct. Think of it as a “migration manager”, “migrator”, “runner”). It can be used to migrate database / data / files / binaries, etc from one version to another.

Implementations

impl<'m, 'c, MigContext, M: Metadata> Migratex<'m, 'c, MigContext, M>

pub fn new( ctx: &'c mut MigContext, meta: &'m mut M, migrations: Vec<BoxMigration<MigContext>>, ) -> Self

Create a new Migratex.

pub fn metadata(&self) -> &M

Get the current metadata.

pub fn context(&self) -> &MigContext

Get the migration context.

pub fn latest_version(&self) -> i32

Get the most recent migration version.

pub async fn migrate_to_latest(&mut self) -> Result<()>

Migrate from current metadata.version up to the latest migration version

pub async fn migrate_to_zero(&mut self) -> Result<()>

Rollback everything (migrate to version 0, before the first migration).

pub async fn migrate_next(&mut self) -> Result<()>

Migrate to the next version (up)

pub async fn migrate_prev(&mut self) -> Result<()>

Migrate to the previous version (down)

pub async fn migrate_to(&mut self, target: i32) -> Result<()>

Migrate to a specific target version (up or down)