Struct MigrationLockOptions 

pub struct MigrationLockOptions { /* private fields */ }

Stable cross-process migration lock configuration.

Implementations

impl MigrationLockOptions

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

Creates options using a deterministic PostgreSQL advisory key derived from namespace.

Products migrating from an existing lock implementation should call Self::with_postgres_advisory_key to preserve the old key during rolling upgrades.

pub const fn with_postgres_advisory_key(self, key: i64) -> Self

Overrides the PostgreSQL advisory key while preserving the shared namespace for MySQL.

pub const fn with_postgres_transaction(self, enabled: bool) -> Self

Controls the PostgreSQL callback transaction (default: true). Disable for migrators containing CREATE INDEX CONCURRENTLY or independently committed backfills. The dedicated session still owns the migration lock.

pub const fn with_mysql_timeout_seconds(self, seconds: u64) -> Self

Overrides the MySQL named-lock wait timeout in whole seconds.

pub fn namespace(&self) -> &str

Returns the stable product namespace used for MySQL named locks.

pub const fn postgres_advisory_key(&self) -> i64

Returns the PostgreSQL advisory-lock key.

pub const fn mysql_timeout_seconds(&self) -> u64

Returns the MySQL named-lock wait timeout in seconds.

Trait Implementations

impl Clone for MigrationLockOptions

fn clone(&self) -> MigrationLockOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MigrationLockOptions

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

Formats the value using the given formatter.

impl PartialEq for MigrationLockOptions

fn eq(&self, other: &MigrationLockOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for MigrationLockOptions

impl StructuralPartialEq for MigrationLockOptions