Enum MigrationCommands 

pub enum MigrationCommands {
    New {
        name: String,
    },
    Pin {
        migration: String,
    },
    Build {
        pinned: bool,
        migration: String,
        variables: Option<String>,
    },
    Apply {
        no_pin: bool,
        migration: Option<String>,
        variables: Option<String>,
        yes: bool,
        retry: bool,
    },
    Adopt {
        migration: Option<String>,
        yes: bool,
        description: Option<String>,
    },
    Status,
}

Variants

New

Create a new migration with the provided name

Fields

name: String

Name of the migration.

Pin

Pin a migration with current components

Fields

migration: String

Migration to pin

Build

Build a migration into SQL

Fields

pinned: bool

Whether to use pinned components

migration: String

Migration to build. Looks for up.sql inside this specified migration folder.

variables: Option<String>

Path to a variables file (JSON, TOML, or YAML) to use for templating. Overrides the variables_file setting in spawn.toml.

Apply

Apply will apply this migration to the database if not already applied, or all migrations if called without argument.

Fields

no_pin: bool

Skip the pin requirement and use unpinned components

migration: Option<String>

variables: Option<String>

Path to a variables file (JSON, TOML, or YAML) to use for templating. Overrides the variables_file setting in spawn.toml.

yes: bool

Skip confirmation prompt

retry: bool

Retry a previously failed migration

Adopt

Mark a migration as applied without actually running it. Useful when a migration was applied manually and needs to be recorded.

Fields

migration: Option<String>

Migration to adopt

yes: bool

Skip confirmation prompt

description: Option<String>

Description of why the migration is being adopted

Status

Show the status of all migrations

Trait Implementations

impl FromArgMatches for MigrationCommands

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 MigrationCommands

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

impl TelemetryDescribe for MigrationCommands

fn telemetry(&self) -> TelemetryInfo