Struct Migrator

pub struct Migrator<'t, S> { /* private fields */ }

Migrator is used to apply database migrations.

When all migrations are done, it can be turned into a Database instance with Migrator::finish.

Implementations

impl<'t, S: Schema> Migrator<'t, S>

pub fn migrate<M, N: Schema>(self, m: M) -> Migrator<'t, N>

where M: Migration<'t, From = S, To = N>,

Apply a database migration if the current schema is S and return a Migrator for the next schema N.

This function will panic if the schema on disk does not match what is expected for its user_version.

pub fn finish(self) -> Option<Database<S>>

Commit the migration transaction and return a Database.

Returns None if the database schema version is newer than S.