Struct Migrations 

pub struct Migrations { /* private fields */ }

Collection of database migrations.

Implementations

impl Migrations

pub fn new() -> Self

Creates a new empty migrations collection.

pub fn add_migration(&mut self, migration: Arc<dyn Migration>)

Adds a migration to the collection.

pub fn check(&self, db: &ReadOnlyDB, include_background: bool) -> Ordering

Check if database’s version is matched with the executable binary version.

Returns

• Less: The database version is less than the matched version of the executable binary. Requires migration.
• Equal: The database version is matched with the executable binary version.
• Greater: The database version is greater than the matched version of the executable binary. Requires upgrade the executable binary.

pub fn expensive(&self, db: &ReadOnlyDB, include_background: bool) -> bool

Check if the migrations will consume a lot of time.

pub fn can_run_in_background(&self, db: &ReadOnlyDB) -> bool

Check if all the pending migrations will be executed in background.

pub fn init_db_version(&self, db: &RocksDB) -> Result<(), Error>

Initial db version

pub fn migrate( &self, db: RocksDB, run_in_background: bool, ) -> Result<RocksDB, Error>

Runs pending migrations on the database.

If run_in_background is true, long-running migrations will be executed asynchronously.

Trait Implementations

impl Default for Migrations

fn default() -> Migrations

Returns the “default value” for a type.