Struct ckb_db_migration::DefaultMigration

pub struct DefaultMigration { /* private fields */ }

TODO(doc): @quake

Implementations

impl DefaultMigration

pub fn new(version: &str) -> Self

TODO(doc): @quake

Trait Implementations

impl Migration for DefaultMigration

fn migrate( &self, db: RocksDB, _pb: Arc<dyn Fn(u64) -> ProgressBar + Send + Sync> ) -> Result<RocksDB, Error>

TODO(doc): @quake

fn version(&self) -> &str

returns migration version, use date +'%Y%m%d%H%M%S' timestamp format

fn expensive(&self) -> bool

Will cost a lot of time to perform this migration operation.

fn run_in_background(&self) -> bool

Will this migration be executed in background.

fn stop_background(&self) -> bool

Check if the background migration should be stopped. If a migration need to implement the recovery logic, it should check this flag periodically, store the migration progress when exiting and recover from the current progress when restarting.

fn can_resume(&self) -> bool

Check if the background migration can be resumed.