Struct rocksdb::backup::BackupEngine

pub struct BackupEngine { /* fields omitted */ }

Methods

impl BackupEngine

pub fn open<P: AsRef<Path>>(
    opts: &BackupEngineOptions,
    path: P
) -> Result<BackupEngine, Error>

Open a backup engine with the specified options.

pub fn create_new_backup(&mut self, db: &DB) -> Result<(), Error>

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

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

Example

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());
 }

Trait Implementations

impl Drop for BackupEngine

fn drop(&mut self)

Executes the destructor for this type.