Struct migrant_lib::Config

pub struct Config {
    pub path: PathBuf,
    // some fields omitted
}

Project configuration/settings

Fields

path: PathBuf

Methods

impl Config

fn use_migrations(
    &mut self,
    migrations: Vec<Box<Migratable>>
) -> Result<&mut Self>

fn is_explicit(&self) -> bool

Migrations are explicitly defined

fn reload(&self) -> Result<Config>

Do a full reload of the configuration file, keeping track of manually specified migrations

fn load_file_only<T: AsRef<Path>>(path: T) -> Result<Config>

Load config file from the given path without querying the database to check for applied migrations

fn load<T: AsRef<Path>>(path: T) -> Result<Config>

Load config file from the given path and query the database to load up applied migrations

fn init_in(dir: &Path) -> ConfigInitializer

Start a config initializer in the given directory

fn setup(&self) -> Result<bool>

• Confirm the database can be accessed
• Setup the database migrations table if it doesn't exist yet

fn migration_dir(&self) -> Result<PathBuf>

Return the absolute path to the directory containing migration folders

fn database_type(&self) -> Result<String>

Return the database type

fn database_path(&self) -> Result<PathBuf>

Return the absolute path to the database file. This is intended for sqlite3 databases only

fn connect_string(&self) -> Result<String>

Generate a database connection string. Not intended for file-based databases (sqlite)

Trait Implementations

impl Debug for Config

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.