Struct Waypoint 

pub struct Waypoint {
    pub config: WaypointConfig,
    /* private fields */
}

Main entry point for the Waypoint library.

Create a Waypoint instance with a config and use its methods to run migration commands programmatically.

Fields

config: WaypointConfig

Implementations

impl Waypoint

pub async fn new(config: WaypointConfig) -> Result<Self>

Create a new Waypoint instance, connecting to the database.

If connect_retries is configured, retries with exponential backoff.

pub fn with_client(config: WaypointConfig, client: Client) -> Self

Create a new Waypoint instance with an existing database client.

pub fn client(&self) -> &Client

Get a reference to the underlying database client.

pub async fn migrate( &self, target_version: Option<&str>, ) -> Result<MigrateReport>

Apply pending migrations.

pub async fn info(&self) -> Result<Vec<MigrationInfo>>

Show migration status information.

pub async fn validate(&self) -> Result<ValidateReport>

Validate applied migrations against local files.

pub async fn repair(&self) -> Result<RepairReport>

Repair the schema history table.

pub async fn baseline( &self, version: Option<&str>, description: Option<&str>, ) -> Result<()>

Baseline an existing database.

pub async fn undo(&self, target: UndoTarget) -> Result<UndoReport>

Undo applied migrations.

pub async fn clean(&self, allow_clean: bool) -> Result<Vec<String>>

Drop all objects in managed schemas.

pub fn lint( locations: &[PathBuf], disabled_rules: &[String], ) -> Result<LintReport>

Run lint on migration files (no DB required).

pub fn changelog( locations: &[PathBuf], from: Option<&str>, to: Option<&str>, ) -> Result<ChangelogReport>

Generate changelog from migration files (no DB required).

pub async fn diff(&self, target: DiffTarget) -> Result<DiffReport>

Compare database schema against a target.

pub async fn drift(&self) -> Result<DriftReport>

Detect schema drift.

pub async fn snapshot( &self, snapshot_config: &SnapshotConfig, ) -> Result<SnapshotReport>

Take a schema snapshot.

pub async fn restore( &self, snapshot_config: &SnapshotConfig, snapshot_id: &str, ) -> Result<RestoreReport>

Restore from a schema snapshot.

pub async fn explain(&self) -> Result<ExplainReport>

Run enhanced dry-run with EXPLAIN.

pub async fn preflight(&self) -> Result<PreflightReport>

Run pre-flight health checks.

pub fn check_conflicts( locations: &[PathBuf], base_branch: &str, ) -> Result<ConflictReport>

Check for branch conflicts (no DB required).

pub async fn safety(&self) -> Result<SafetyCommandReport>

Analyze pending migrations for safety (lock analysis, impact estimation).

pub async fn advise(&self) -> Result<AdvisorReport>

Run schema advisor to suggest improvements.

pub async fn simulate(&self) -> Result<SimulationReport>

Simulate pending migrations in a throwaway schema.