Enum MigrateCommand 

pub enum MigrateCommand {
    Add(AddMigrationOpts),
    Run {
        source: MigrationSourceOpt,
        config: ConfigOpt,
        dry_run: bool,
        ignore_missing: IgnoreMissing,
        connect_opts: ConnectOpts,
        target_version: Option<i64>,
    },
    Revert {
        source: MigrationSourceOpt,
        config: ConfigOpt,
        dry_run: bool,
        ignore_missing: IgnoreMissing,
        connect_opts: ConnectOpts,
        target_version: Option<i64>,
    },
    Info {
        source: MigrationSourceOpt,
        config: ConfigOpt,
        connect_opts: ConnectOpts,
    },
    BuildScript {
        source: MigrationSourceOpt,
        config: ConfigOpt,
        force: bool,
    },
}

Variants

Add(AddMigrationOpts)

Create a new migration with the given description.

---

Migrations may either be simple, or reversible.

Reversible migrations can be reverted with sqlx migrate revert, simple migrations cannot.

Reversible migrations are created as a pair of two files with the same filename but extensions .up.sql and .down.sql for the up-migration and down-migration, respectively.

The up-migration should contain the commands to be used when applying the migration, while the down-migration should contain the commands to reverse the changes made by the up-migration.

When writing down-migrations, care should be taken to ensure that they do not leave the database in an inconsistent state.

Simple migrations have just .sql for their extension and represent an up-migration only.

Note that reverting a migration is destructive and will likely result in data loss. Reverting a migration will not restore any data discarded by commands in the up-migration.

It is recommended to always back up the database before running migrations.

---

For convenience, this command attempts to detect if reversible migrations are in-use.

If the latest existing migration is reversible, the new migration will also be reversible.

Otherwise, a simple migration is created.

This behavior can be overridden by --simple or --reversible, respectively.

The default type to use can also be set in sqlx.toml.

---

A version number will be automatically assigned to the migration.

Migrations are applied in ascending order by version number. Version numbers do not need to be strictly consecutive.

The migration process will abort if SQLx encounters a migration with a version number less than any previously applied migration.

Migrations should only be created with increasing version number.

---

For convenience, this command will attempt to detect if sequential versioning is in use, and if so, continue the sequence.

Sequential versioning is inferred if:

• The version numbers of the last two migrations differ by exactly 1, or:

• only one migration exists and its version number is either 0 or 1.

Otherwise, timestamp versioning (YYYYMMDDHHMMSS) is assumed.

This behavior can be overridden by --timestamp or --sequential, respectively.

The default versioning to use can also be set in sqlx.toml.

Run

Run all pending migrations.

Fields

source: MigrationSourceOpt

config: ConfigOpt

dry_run: bool

List all the migrations to be run without applying

ignore_missing: IgnoreMissing

connect_opts: ConnectOpts

target_version: Option<i64>

Apply migrations up to the specified version. If unspecified, apply all pending migrations. If already at the target version, then no-op.

Revert

Revert the latest migration with a down file.

Fields

source: MigrationSourceOpt

config: ConfigOpt

dry_run: bool

List the migration to be reverted without applying

ignore_missing: IgnoreMissing

connect_opts: ConnectOpts

target_version: Option<i64>

Revert migrations down to the specified version. If unspecified, revert only the last migration. Set to 0 to revert all migrations. If already at the target version, then no-op.

Info

List all available migrations.

Fields

source: MigrationSourceOpt

config: ConfigOpt

connect_opts: ConnectOpts

BuildScript

Generate a build.rs to trigger recompilation when a new migration is added.

Must be run in a Cargo project root.

Fields

source: MigrationSourceOpt

config: ConfigOpt

force: bool

Overwrite the build script if it already exists.

Trait Implementations

impl CommandFactory for MigrateCommand

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 MigrateCommand

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

Formats the value using the given formatter.

impl FromArgMatches for MigrateCommand

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 MigrateCommand

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 MigrateCommand

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