Enum Operation

pub enum Operation {
    Migrate {
        name: Option<String>,
        version: Option<u64>,
    },
    Revert {
        name: Option<String>,
        version: Option<u64>,
    },
    Set {
        name: Option<String>,
        version: Option<u64>,
    },
    Check {},
    Status {},
    Add {
        sql: bool,
        reversible: bool,
        ty: DatabaseType,
        name: String,
    },
}

Available on crate feature cli only.

A command-line operation.

Variants

Migrate

Apply all migrations up to and including the given migration.

If no migration is given, all migrations are applied.

Fields

name: Option<String>

Apply all migrations up to and including the migration with the given name.

version: Option<u64>

Apply all migrations up to and including the migration with the given version.

Revert

Revert the given migration and all subsequent ones.

If no migration is set, all applied migrations are reverted.

Fields

name: Option<String>

Revert all migrations after and including the migration with the given name.

version: Option<u64>

Revert all migrations after and including the migration the given version.

Set

Forcibly set a given migration.

This does not apply nor revert any migrations, and only overrides migration status.

Fields

name: Option<String>

Forcibly set the migration with the given name.

version: Option<u64>

Forcibly set the migration with the given version.

Check

Verify migrations and print errors.

Status

List all migrations.

Add

Add a new migration.

The migrations default to Rust files.

Fields

sql: bool

Use SQL for the migrations.

reversible: bool

Create a “revert” or “down” migration.

ty: DatabaseType

The SQLx type of the database in Rust migrations.

By default, all migrations will be using Any.

name: String

The name of the migration.

It must be across all migrations.

Trait Implementations

impl Debug for Operation

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

Formats the value using the given formatter.

impl FromArgMatches for Operation

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 Operation

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