Struct SqlCommand 

pub struct SqlCommand {
    pub query: Option<String>,
    pub file: Option<String>,
    pub fetch_size: Option<usize>,
    pub max_rows: Option<usize>,
    pub deadline: Option<String>,
    pub read_mode: Option<SqlReadMode>,
    pub routing_report: Option<RoutingReportFormat>,
    pub tui: bool,
}

SQL subcommand

Multiple ;-separated statements are executed in a single transaction and each statement emits its own result block. With --output json the output is always an array of per-statement result sets (a single statement yields a 1-element array); DDL/DML statements contribute a status/message result set unless --quiet is set.

Fields

query: Option<String>

SQL query to execute (may contain multiple ;-separated statements)

file: Option<String>

File containing SQL query

fetch_size: Option<usize>

Fetch size for server streaming

max_rows: Option<usize>

Max rows to return before stopping

deadline: Option<String>

Deadline for query execution (e.g. 60s, 5m)

read_mode: Option<SqlReadMode>

Read routing mode. Non-local modes require an explicit cluster profile.

routing_report: Option<RoutingReportFormat>

Emit a distributed-read routing report to stderr without changing SQL row output on stdout.

tui: bool

Launch interactive TUI preview

Implementations

impl SqlCommand

pub fn resolve_query(&self, batch_mode: &BatchMode) -> Result<String>

Resolve the SQL query source (argument, file, or stdin).

Trait Implementations

impl Args for SqlCommand

fn group_id() -> Option<Id>

Report the 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 SqlCommand

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 SqlCommand

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

Formats the value using the given formatter.

impl FromArgMatches for SqlCommand

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 SqlCommand

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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.