Enum Command

pub(crate) enum Command {
    Catalogs,
    DbSchemas {
        catalog: String,
        db_schema_filter: Option<String>,
    },
    Tables {
        catalog: String,
        db_schema_filter: Option<String>,
        table_filter: Option<String>,
        table_types: Vec<String>,
    },
    TableTypes,
    StatementQuery {
        query: String,
    },
    PreparedStatementQuery {
        query: String,
        params: Vec<(String, String)>,
    },
}

Different available commands.

Variants

Catalogs

Get catalogs.

DbSchemas

Get db schemas for a catalog.

Fields

catalog: String

Name of a catalog.

Required.

db_schema_filter: Option<String>

Specifies a filter pattern for schemas to search for. When no schema_filter is provided, the pattern will not be used to narrow the search. In the pattern string, two special characters can be used to denote matching rules: - “%” means to match any substring with 0 or more characters. - “_” means to match any one character.

Tables

Get tables for a catalog.

Fields

catalog: String

Name of a catalog.

Required.

db_schema_filter: Option<String>

Specifies a filter pattern for schemas to search for. When no schema_filter is provided, the pattern will not be used to narrow the search. In the pattern string, two special characters can be used to denote matching rules: - “%” means to match any substring with 0 or more characters. - “_” means to match any one character.

table_filter: Option<String>

Specifies a filter pattern for tables to search for. When no table_filter is provided, all tables matching other filters are searched. In the pattern string, two special characters can be used to denote matching rules: - “%” means to match any substring with 0 or more characters. - “_” means to match any one character.

table_types: Vec<String>

Specifies a filter of table types which must match. The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables. TABLE, VIEW, and SYSTEM TABLE are commonly supported.

TableTypes

Get table types.

StatementQuery

Execute given statement.

Fields

query: String

SQL query.

Required.

PreparedStatementQuery

Prepare given statement and then execute it.

Fields

query: String

SQL query.

Required.

Can contains placeholders like $1.

Example: SELECT * FROM t WHERE x = $1

params: Vec<(String, String)>

Additional parameters.

Can be given multiple times. Names and values are separated by ‘=’. Values will be converted to the type that the server reported for the prepared statement.

Example: -p $1=42

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.

impl FromArgMatches for Command

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<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for Command

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

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

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

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

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand