Struct ExportCommand 

pub struct ExportCommand {

    addr: String,
    output_dir: Option<String>,
    database: String,
    db_parallelism: usize,
    table_parallelism: usize,
    max_retry: usize,
    target: ExportTarget,
    start_time: Option<String>,
    end_time: Option<String>,
    auth_basic: Option<String>,
    timeout: Option<Duration>,
    proxy: Option<String>,
    no_proxy: bool,
    ddl_local_dir: Option<String>,
    storage: ObjectStoreConfig,
}

Command for exporting data from the GreptimeDB.

Fields

addr: String

Server address to connect

output_dir: Option<String>

Directory to put the exported data. E.g.: /tmp/greptimedb-export for local export.

database: String

The name of the catalog to export.

db_parallelism: usize

The number of databases exported in parallel. For example, if there are 20 databases and db_parallelism is 4, 4 databases will be exported concurrently.

table_parallelism: usize

The number of tables exported in parallel within a single database. For example, if a database has 30 tables and parallelism is 8, 8 tables will be exported concurrently.

max_retry: usize

Max retry times for each job.

target: ExportTarget

Things to export

start_time: Option<String>

A half-open time range: [start_time, end_time). The start of the time range (time-index column) for data export.

end_time: Option<String>

A half-open time range: [start_time, end_time). The end of the time range (time-index column) for data export.

auth_basic: Option<String>

The basic authentication for connecting to the server

timeout: Option<Duration>

The timeout of invoking the database.

It is used to override the server-side timeout setting. The default behavior will disable server-side default timeout(i.e. 0s).

proxy: Option<String>

The proxy server address to connect.

If set, it overrides the system proxy unless --no-proxy is specified. If neither --proxy nor --no-proxy is set, system proxy (env) may be used.

no_proxy: bool

Disable all proxy usage (ignores --proxy and system proxy).

When set and --proxy is not provided, this explicitly disables system proxy.

ddl_local_dir: Option<String>

if both ddl_local_dir and remote storage are set, ddl_local_dir will be only used for exported SQL files, and the data will be exported to remote storage.

Note that ddl_local_dir export sql files to LOCAL file system, this is useful if export client don’t have direct access to remote storage.

if remote storage is set but ddl_local_dir is not set, both SQL&data will be exported to remote storage.

storage: ObjectStoreConfig

Implementations

impl ExportCommand

pub async fn build(&self) -> Result<Box<dyn Tool>, BoxedError>

Trait Implementations

impl Args for ExportCommand

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 via [FromArgMatches::from_arg_matches_mut]

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

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl CommandFactory for ExportCommand

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for ExportCommand

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

Formats the value using the given formatter.

impl Default for ExportCommand

fn default() -> ExportCommand

Returns the “default value” for a type.

impl FromArgMatches for ExportCommand

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.

impl Parser for ExportCommand

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.