Skip to main content

run

mz_deploy::cli::commands::wait

Function run 

Source 
pub async fn run(
    settings: &Settings,
    deploy_id: &str,
    once: bool,
    timeout: Option<u64>,
    allowed_lag_secs: i64,
) -> Result<(), CliError>
Expand description

Wait for a staging deployment to become ready by monitoring hydration status.

This command:

  • Validates the staging deployment exists and hasn’t been promoted
  • Subscribes to cluster hydration status
  • Shows a live dashboard tracking hydration, lag, and health for each cluster
  • Exits when all clusters are ready or timeout is reached

§Arguments

  • settings - Resolved CLI settings (profile, project directory, etc.)
  • deploy_id - Staging deployment ID
  • once - If true, check once and exit; if false, track continuously
  • timeout - Optional timeout in seconds
  • allowed_lag_secs - Maximum allowed lag in seconds before marking as “lagging”

§Returns

Ok(()) once the deployment is ready.

§Errors

Surfaces connection errors (including unknown or already-promoted deployments) and CliError::ReadyTimeout when the timeout is reached.