Struct rocksdb::backup::BackupEngine

source ·
pub struct BackupEngine { /* private fields */ }

Implementations§

source§

impl BackupEngine

source

pub fn open(opts: &BackupEngineOptions, env: &Env) -> Result<Self, Error>

Open a backup engine with the specified options and RocksDB Env.

source

pub fn create_new_backup<T: ThreadMode, D: DBInner>( &mut self, db: &DBCommon<T, D>, ) -> Result<(), Error>

Captures the state of the database in the latest backup.

Note: no flush before backup is performed. User might want to use create_new_backup_flush instead.

source

pub fn create_new_backup_flush<T: ThreadMode, D: DBInner>( &mut self, db: &DBCommon<T, D>, flush_before_backup: bool, ) -> Result<(), Error>

Captures the state of the database in the latest backup.

Set flush_before_backup=true to avoid losing unflushed key/value pairs from the memtable.

source

pub fn purge_old_backups( &mut self, num_backups_to_keep: usize, ) -> Result<(), Error>

source

pub fn restore_from_latest_backup<D: AsRef<Path>, W: AsRef<Path>>( &mut self, db_dir: D, wal_dir: W, opts: &RestoreOptions, ) -> Result<(), Error>

Restore from the latest backup

§Arguments
  • db_dir - A path to the database directory
  • wal_dir - A path to the wal directory
  • opts - Restore options
§Examples
use rocksdb::backup::{BackupEngine, BackupEngineOptions};
let backup_opts = BackupEngineOptions::default();
let mut backup_engine = BackupEngine::open(&backup_opts, &backup_path).unwrap();
let mut restore_option = rocksdb::backup::RestoreOptions::default();
restore_option.set_keep_log_files(true); /// true to keep log files
if let Err(e) = backup_engine.restore_from_latest_backup(&db_path, &wal_dir, &restore_option) {
    error!("Failed to restore from the backup. Error:{:?}", e);
    return Err(e.to_string());
 }
source

pub fn restore_from_backup<D: AsRef<Path>, W: AsRef<Path>>( &mut self, db_dir: D, wal_dir: W, opts: &RestoreOptions, backup_id: u32, ) -> Result<(), Error>

Restore from a specified backup

The specified backup id should be passed in as an additional parameter.

source

pub fn verify_backup(&self, backup_id: u32) -> Result<(), Error>

Checks that each file exists and that the size of the file matches our expectations. it does not check file checksum.

If this BackupEngine created the backup, it compares the files’ current sizes against the number of bytes written to them during creation. Otherwise, it compares the files’ current sizes against their sizes when the BackupEngine was opened.

source

pub fn get_backup_info(&self) -> Vec<BackupEngineInfo>

Get a list of all backups together with information on timestamp of the backup and the size (please note that sum of all backups’ sizes is bigger than the actual size of the backup directory because some data is shared by multiple backups). Backups are identified by their always-increasing IDs.

You can perform this function safely, even with other BackupEngine performing backups on the same directory

Trait Implementations§

source§

impl Drop for BackupEngine

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.