Struct rusqlite_migration::MigrationsBuilder

pub struct MigrationsBuilder<'u> { /* private fields */ }

Available on crate feature from-directory only.

Allows to build a Vec<M<'u>> with additional edits.

Implementations

impl<'u> MigrationsBuilder<'u>

pub fn from_directory(dir: &'static Dir<'static>) -> Result<Self>

Creates a set of migrations from a given directory by scanning subdirectories with a specified name pattern. The migrations are loaded and stored in the binary.

See the crate::Migrations::from_directory method for additional information regarding the directory structure.

Example

use rusqlite_migration::{Migrations, MigrationsBuilder};
use include_dir::{Dir, include_dir};

static MIGRATION_DIR: Dir = include_dir!("$CARGO_MANIFEST_DIR/../examples/from-directory/migrations");
let migrations: Migrations = MigrationsBuilder::from_directory(&MIGRATION_DIR).unwrap().finalize();

Errors

Returns crate::Error::FileLoad in case the subdirectory names are incorrect, or don’t contain at least a valid up.sql file.

pub fn edit(self, id: usize, f: impl Fn(M<'_>) -> M<'_>) -> Self

Allows to edit a migration with a given id.

Panics

Panics if no migration with the id provided exists.

pub fn finalize<T: FromIterator<M<'u>>>(self) -> T

Finalizes the builder and creates either a crate::Migrations or a crate::AsyncMigrations instance.

Trait Implementations

impl<'u> Debug for MigrationsBuilder<'u>

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

Formats the value using the given formatter.

impl<'u> Default for MigrationsBuilder<'u>

fn default() -> MigrationsBuilder<'u>

Returns the “default value” for a type.

impl<'u> FromIterator<M<'u>> for MigrationsBuilder<'u>

fn from_iter<T: IntoIterator<Item = M<'u>>>(iter: T) -> Self

Creates a value from an iterator.