Skip to main content

WaypointConfig

Struct WaypointConfig 

Source
pub struct WaypointConfig {
Show 13 fields pub database: DatabaseConfig, pub migrations: MigrationSettings, pub hooks: HooksConfig, pub placeholders: HashMap<String, String>, pub lint: LintConfig, pub snapshots: SnapshotConfig, pub preflight: PreflightConfig, pub multi_database: Option<Vec<NamedDatabaseConfig>>, pub guards: GuardsConfig, pub reversals: ReversalConfig, pub safety: SafetyConfig, pub advisor: AdvisorConfig, pub simulation: SimulationConfig,
}
Expand description

Top-level configuration for Waypoint.

Fields§

§database: DatabaseConfig

Database connection settings (URL, host, port, credentials, etc.).

§migrations: MigrationSettings

Migration behavior settings (locations, table name, ordering, etc.).

§hooks: HooksConfig

SQL callback hook configuration for before/after migration phases.

§placeholders: HashMap<String, String>

Key-value placeholder substitutions applied to migration SQL.

§lint: LintConfig

Lint rule configuration.

§snapshots: SnapshotConfig

Schema snapshot configuration for drift detection.

§preflight: PreflightConfig

Pre-flight check configuration run before migrations.

§multi_database: Option<Vec<NamedDatabaseConfig>>

Optional multi-database configuration for parallel migration targets.

§guards: GuardsConfig

Guard (pre/post condition) configuration.

§reversals: ReversalConfig

Auto-reversal generation configuration.

§safety: SafetyConfig

Safety analysis configuration.

§advisor: AdvisorConfig

Schema advisor configuration.

§simulation: SimulationConfig

Migration simulation configuration.

Implementations§

Source§

impl WaypointConfig

Source

pub fn load(config_path: Option<&str>, overrides: &CliOverrides) -> Result<Self>

Load configuration with the following priority (highest wins):

  1. CLI arguments
  2. Environment variables
  3. TOML config file
  4. Built-in defaults
Source

pub fn connection_string(&self) -> Result<String>

Build a connection string from the config. Prefers url if set; otherwise builds from individual fields. Handles JDBC-style URLs by stripping the jdbc: prefix and extracting user and password query parameters.

Trait Implementations§

Source§

impl Clone for WaypointConfig

Source§

fn clone(&self) -> WaypointConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WaypointConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WaypointConfig

Source§

fn default() -> WaypointConfig

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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