Struct Config 

pub struct Config { /* private fields */ }

Main configuration structure

Supports both single-database (legacy) and multi-database configurations:

Single database:

dialect = "sqlite"
[dbCredentials]
url = "./dev.db"

Multiple databases:

[databases.dev]
dialect = "sqlite"
[databases.dev.dbCredentials]
url = "./dev.db"

[databases.prod]
dialect = "postgresql"
[databases.prod.dbCredentials]
url = { env = "DATABASE_URL" }

Implementations

impl Config

pub fn load() -> Result<Self, Error>

Load from default config file

pub fn load_from(path: &Path) -> Result<Self, Error>

Load from specific path

pub fn is_single_database(&self) -> bool

Check if this is a single-database config

pub fn database_names(&self) -> impl Iterator<Item = &str>

Get all database names

pub fn database(&self, name: Option<&str>) -> Result<&DatabaseConfig, Error>

Get a specific database config by name

If name is None, returns the default/only database. For single-db configs, any name or None returns the single database.

pub fn default_database(&self) -> Result<&DatabaseConfig, Error>

Get the default database (for single-db mode or when only one db exists)

pub fn dialect(&self) -> Dialect

Get dialect (for single-db mode backwards compat)

pub fn credentials(&self) -> Result<Option<Credentials>, Error>

Get credentials (for single-db mode backwards compat)

pub fn migrations_dir(&self) -> &Path

Get migrations directory (for single-db mode backwards compat)

pub fn journal_path(&self) -> PathBuf

Get journal path (for single-db mode backwards compat)

pub fn schema_display(&self) -> String

Get schema display (for single-db mode backwards compat)

pub fn schema_files(&self) -> Result<Vec<PathBuf>, Error>

Get schema files (for single-db mode backwards compat)

pub fn base_dialect(&self) -> Dialect

Base dialect for SQL generation (for single-db mode backwards compat)

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.