Struct ExportCommand

pub struct ExportCommand {

    addr: String,
    output_dir: Option<String>,
    database: String,
    export_jobs: 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,
    s3: bool,
    s3_bucket: Option<String>,
    s3_endpoint: Option<String>,
    s3_access_key: Option<String>,
    s3_secret_key: Option<String>,
    s3_region: Option<String>,
}

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.

export_jobs: usize

Parallelism of the export.

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, will override the system proxy.

The default behavior will use the system proxy if neither proxy nor no_proxy is set.

no_proxy: bool

Disable proxy server, if set, will not use any proxy.

s3: bool

if export data to s3

s3_bucket: Option<String>

The s3 bucket name if s3 is set, this is required

s3_endpoint: Option<String>

The s3 endpoint if s3 is set, this is required

s3_access_key: Option<String>

The s3 access key if s3 is set, this is required

s3_secret_key: Option<String>

The s3 secret key if s3 is set, this is required

s3_region: Option<String>

The s3 region if s3 is set, this is required

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.