Struct ScanbenchCommand 

pub struct ScanbenchCommand {

    config: PathBuf,
    region_id: String,
    table_dir: String,
    scanner: String,
    scan_config: Option<PathBuf>,
    scan_configs: Option<PathBuf>,
    parallelism: usize,
    iterations: usize,
    path_type: String,
    verbose: bool,
    pprof_file: Option<PathBuf>,
    result_file: Option<PathBuf>,
    enable_wal: bool,
    pprof_after_warmup: bool,
}

Scan benchmark command - benchmarks scanning a region directly from storage.

Fields

config: PathBuf

Path to config TOML file (same format as standalone/datanode config)

region_id: String

Region ID: either numeric u64 (e.g. “4398046511104”) or “table_id:region_num” (e.g. “1024:0”)

table_dir: String

Table directory relative to data home (e.g. “data/greptime/public/1024/”)

scanner: String

Scanner type: seq, unordered, series

scan_config: Option<PathBuf>

Path to scan request JSON config file (optional)

scan_configs: Option<PathBuf>

Path to a JSON array of scan request configs, each executed once

parallelism: usize

Number of partitions for parallel scan (simulates parallelism)

iterations: usize

Number of iterations for benchmarking

path_type: String

Path type for the region: bare, data, metadata

verbose: bool

Verbose output

pprof_file: Option<PathBuf>

Output pprof flamegraph

result_file: Option<PathBuf>

Output structured benchmark and analyze results as JSON

enable_wal: bool

Enable WAL replay when opening the region.

pprof_after_warmup: bool

Start pprof after the first iteration (use first iteration as warmup).

Implementations

impl ScanbenchCommand

async fn load_scan_config_set(&self) -> Result<ScanConfigSet>

pub async fn run(&self) -> Result<()>

Trait Implementations

impl Args for ScanbenchCommand

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 ScanbenchCommand

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 ScanbenchCommand

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

Formats the value using the given formatter.

impl FromArgMatches for ScanbenchCommand

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 ScanbenchCommand

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.