Struct MigrationSettings 

pub struct MigrationSettings {
    pub locations: Vec<PathBuf>,
    pub table: String,
    pub schema: String,
    pub out_of_order: bool,
    pub validate_on_migrate: bool,
    pub clean_enabled: bool,
    pub baseline_version: String,
    pub installed_by: Option<String>,
    pub environment: Option<String>,
    pub dependency_ordering: bool,
    pub show_progress: bool,
    pub batch_transaction: bool,
}

Migration behavior settings.

Fields

locations: Vec<PathBuf>

Filesystem directories to scan for migration SQL files.

table: String

Name of the schema history table.

schema: String

Database schema where the history table resides.

out_of_order: bool

Whether to allow applying migrations with versions below the highest applied version.

validate_on_migrate: bool

Whether to validate already-applied migration checksums before migrating.

clean_enabled: bool

Whether the clean command is allowed to run.

baseline_version: String

Version to use when running the baseline command.

installed_by: Option<String>

Custom value for the installed_by column (defaults to database user).

environment: Option<String>

Logical environment name (e.g., “production”, “staging”) for filtering.

dependency_ordering: bool

Whether to use @depends directives to order migrations topologically.

show_progress: bool

Whether to display a progress indicator during migration.

batch_transaction: bool

Whether to wrap all pending migrations in a single transaction (all-or-nothing).

Trait Implementations

impl Clone for MigrationSettings

fn clone(&self) -> MigrationSettings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MigrationSettings

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

Formats the value using the given formatter.

impl Default for MigrationSettings

fn default() -> Self

Returns the “default value” for a type.