Skip to main content

MigrationManager

Struct MigrationManager 

Source
pub struct MigrationManager { /* private fields */ }
Expand description

Central migration system manager that orchestrates schema evolution.

The MigrationManager maintains the complete registry of available migrations and provides the logic for applying them in the correct order. It ensures that migrations are applied atomically and tracks their completion status.

ยงArchitecture

  • Migration Registry: Stores all available migrations in version order
  • Version Control: Tracks current schema version and pending changes
  • Transaction Management: Ensures each migration is atomic
  • Error Recovery: Provides rollback on migration failures

ยงThread Safety

The migration manager is designed for single-threaded use during application startup. Multiple concurrent migration attempts should be avoided.

Implementationsยง

Sourceยง

impl MigrationManager

Source

pub fn new() -> Self

Creates a new migration manager with all registered migrations.

This constructor automatically registers all available migrations in the correct order. The registration process is deterministic and ensures consistent schema evolution across all environments.

ยงReturns

Returns a fully initialized migration manager ready to apply pending schema changes.

ยงExample
use kasl::db::migrations::MigrationManager;

let manager = MigrationManager::new();
// Manager is ready to apply migrations
Source

pub fn run_migrations(&self, conn: &mut Connection) -> Result<()>

Executes all pending migrations in the correct order.

This method performs the complete migration process:

  1. Creates the migrations tracking table if needed
  2. Determines current database version
  3. Identifies pending migrations
  4. Applies each migration within a transaction
  5. Records successful migrations in the tracking table
ยงTransaction Safety

Each migration runs in its own transaction, ensuring that partial failures donโ€™t leave the database in an inconsistent state. If any migration fails, all changes are rolled back automatically.

ยงArguments
  • conn - Mutable database connection for applying migrations
ยงReturns

Returns Ok(()) if all migrations succeed, or an error if any migration fails during application.

ยงExample
use kasl::db::migrations::MigrationManager;
use rusqlite::Connection;

let manager = MigrationManager::new();
let mut conn = Connection::open(":memory:")?;
manager.run_migrations(&mut conn)?;
Source

pub fn is_migration_applied( &self, conn: &Connection, version: u32, ) -> Result<bool>

Checks if a specific migration version has been applied.

This utility method allows callers to verify whether a particular migration has been successfully applied to the database. Useful for conditional logic based on schema capabilities.

ยงArguments
  • conn - Database connection for querying migration status
  • version - Migration version number to check
ยงReturns

Returns true if the migration has been applied, false otherwise.

ยงExample
use kasl::db::migrations::MigrationManager;
use rusqlite::Connection;

let manager = MigrationManager::new();
let mut conn = Connection::open(":memory:")?;
manager.run_migrations(&mut conn)?;
if manager.is_migration_applied(&conn, 3)? {
    // Tags system is available
}
Source

pub fn get_migration_history( &self, conn: &Connection, ) -> Result<Vec<(u32, String, String)>>

Retrieves the complete migration history with timestamps.

This method returns a chronological list of all applied migrations, including their version numbers, names, and application timestamps. Useful for auditing and debugging schema evolution.

ยงArguments
  • conn - Database connection for querying migration history
ยงReturns

Returns a vector of tuples containing (version, name, applied_at) for each applied migration, ordered by version number.

ยงExample
use kasl::db::migrations::MigrationManager;
use rusqlite::Connection;

let manager = MigrationManager::new();
let mut conn = Connection::open(":memory:")?;
manager.run_migrations(&mut conn)?;
let history = manager.get_migration_history(&conn)?;
for (version, name, applied_at) in history {
    println!("v{}: {} ({})", version, name, applied_at);
}
Source

pub fn rollback_to( &self, conn: &mut Connection, target_version: u32, ) -> Result<()>

Rolls back migrations to a specific target version (debug builds only).

This development utility allows rolling back migrations to a previous schema version by removing migration records from the tracking table.

ยงโš ๏ธ Important Notes
  • Only available in debug builds for safety
  • This is a simplified rollback that removes migration records
  • Does not actually reverse schema changes (no down() functions)
  • Primarily useful for development and testing scenarios
ยงArguments
  • conn - Mutable database connection for rollback operations
  • target_version - Target version to roll back to
ยงReturns

Returns Ok(()) if rollback succeeds, or an error if the operation fails.

ยงExample
use kasl::db::migrations::MigrationManager;
use rusqlite::Connection;

#[cfg(debug_assertions)]
{
    let manager = MigrationManager::new();
    let mut conn = Connection::open(":memory:")?;
    manager.run_migrations(&mut conn)?;
    manager.rollback_to(&mut conn, 2)?; // Roll back to version 2
}

Trait Implementationsยง

Sourceยง

impl Default for MigrationManager

Sourceยง

fn default() -> Self

Returns the โ€œdefault valueโ€ for a type. Read more

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Sourceยง

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Sourceยง

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

Sourceยง

impl<T> Instrument for T

Sourceยง

fn instrument(self, span: Span) -> Instrumented<Self> โ“˜

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Sourceยง

fn in_current_span(self) -> Instrumented<Self> โ“˜

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Sourceยง

impl<T> NoneValue for T
where T: Default,

Sourceยง

type NoneType = T

Sourceยง

fn null_value() -> T

The none-equivalent value.
Sourceยง

impl<T> NoneValue for T
where T: Default,

Sourceยง

type NoneType = T

Sourceยง

fn null_value() -> T

The none-equivalent value.
Sourceยง

impl<T> PolicyExt for T
where T: ?Sized,

Sourceยง

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Sourceยง

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Sourceยง

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Sourceยง

impl<T> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Sourceยง

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Sourceยง

fn vzip(self) -> V

Sourceยง

impl<T> WithSubscriber for T

Sourceยง

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> โ“˜
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Sourceยง

fn with_current_subscriber(self) -> WithDispatch<Self> โ“˜

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more