Enum Command 

pub enum Command {
    Database(DatabaseOpt),
    Prepare {
        check: bool,
        all: bool,
        workspace: bool,
        args: Vec<String>,
        connect_opts: ConnectOpts,
        config: ConfigOpt,
    },
    Migrate(MigrateOpt),
    Completions {
        shell: Shell,
    },
}

Variants

Database(DatabaseOpt)

Prepare

Generate query metadata to support offline compile-time verification.

Saves metadata for all invocations of query! and related macros to a .sqlx directory in the current directory (or workspace root with --workspace), overwriting if needed.

During project compilation, the absence of the DATABASE_URL environment variable or the presence of SQLX_OFFLINE (with a value of true or 1) will constrain the compile-time verification to only read from the cached query metadata.

Fields

check: bool

Run in ‘check’ mode. Exits with 0 if the query metadata is up-to-date. Exits with 1 if the query metadata needs updating.

all: bool

Prepare query macros in dependencies that exist outside the current crate or workspace.

workspace: bool

Generate a single workspace-level .sqlx folder.

This option is intended for workspaces where multiple crates use SQLx. If there is only one, it is better to run cargo sqlx prepare without this option inside that crate.

args: Vec<String>

Arguments to be passed to cargo rustc ....

connect_opts: ConnectOpts

config: ConfigOpt

Migrate(MigrateOpt)

Completions

Generate shell completions for the specified shell

Fields

shell: Shell

Trait Implementations

impl CommandFactory for Command

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 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 Parser for Command

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.

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