Struct MigrationOptions 

#[non_exhaustive]
pub struct MigrationOptions {
    pub version_table: String,
}

Runtime options controlling how Vespertide tracks applied migrations.

Pass this to the migration runner to configure the version-tracking table name. The default table name used by the vespertide_migration! macro is "vespertide_migrations".

MigrationOptions is #[non_exhaustive], so external callers must construct via MigrationOptions::new() or Default::default() rather than struct literals.

Construction:

use vespertide_core::MigrationOptions;

// Named constructor — preferred when overriding the version table.
let opts = MigrationOptions::new("app_migrations");
assert_eq!(opts.version_table, "app_migrations");

// Default gives the standard tracking table name.
let default_opts = MigrationOptions::default();
assert_eq!(default_opts.version_table, "vespertide_migrations");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version_table: String

Name of the table used to record which migration versions have been applied.

Defaults to "vespertide_migrations". Override this when multiple Vespertide-managed schemas share the same database and need separate version tables.

Implementations

impl MigrationOptions

pub fn new(version_table: impl Into<String>) -> Self

Create a new MigrationOptions with the specified version table name.

Construction via new:

use vespertide_core::MigrationOptions;

let opts = MigrationOptions::new("tenant_migrations");
assert_eq!(opts.version_table, "tenant_migrations");

Trait Implementations

impl Clone for MigrationOptions

fn clone(&self) -> MigrationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MigrationOptions

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

Formats the value using the given formatter.

impl Default for MigrationOptions

fn default() -> Self

Returns the “default value” for a type.