Struct RestoreOpts

pub struct RestoreOpts {

    pub meta_snapshot_id: u64,
    pub meta_store_type: MetaBackend,
    pub sql_endpoint: String,
    pub sql_username: String,
    pub sql_password: String,
    pub sql_database: String,
    pub backup_storage_url: String,
    pub backup_storage_directory: String,
    pub hummock_storage_url: String,
    pub hummock_storage_directory: String,
    pub dry_run: bool,
    pub read_attempt_timeout_ms: u64,
    pub read_retry_attempts: u64,
    pub overwrite_hummock_storage_endpoint: bool,
    pub overwrite_backup_storage_url: Option<String>,
    pub overwrite_backup_storage_directory: Option<String>,
}

Command-line arguments for restore.

Fields

meta_snapshot_id: u64

Id of snapshot used to restore. Available snapshots can be found in <storage_directory>/manifest.json.

meta_store_type: MetaBackend

Type of meta store to restore.

sql_endpoint: String

sql_username: String

Username of sql backend, required when meta backend set to MySQL or PostgreSQL.

sql_password: String

Password of sql backend, required when meta backend set to MySQL or PostgreSQL.

sql_database: String

Database of sql backend, required when meta backend set to MySQL or PostgreSQL.

backup_storage_url: String

Url of storage to fetch meta snapshot from.

backup_storage_directory: String

Directory of storage to fetch meta snapshot from.

hummock_storage_url: String

Url of storage to restore hummock version to.

hummock_storage_directory: String

Directory of storage to restore hummock version to.

dry_run: bool

Print the target snapshot, but won’t restore to meta store.

read_attempt_timeout_ms: u64

The read timeout for object store

read_retry_attempts: u64

The maximum number of read retry attempts for the object store.

overwrite_hummock_storage_endpoint: bool

When enabled, some system parameters of in the restored meta store will be overwritten. Specifically, system parameters state_store, data_directory, backup_storage_url and backup_storage_directory will be overwritten with the specified opts hummock_storage_url, hummock_storage_directory, overwrite_backup_storage_url and overwrite_backup_storage_directory.

overwrite_backup_storage_url: Option<String>

overwrite_backup_storage_directory: Option<String>

Trait Implementations

impl Args for RestoreOpts

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for RestoreOpts

fn clone(&self) -> RestoreOpts

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RestoreOpts

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for RestoreOpts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.