Skip to main content

run

Function run 

Source
pub async fn run(
    settings: &Settings,
    show_progress: bool,
) -> Result<Project, CliError>
Expand description

Compile and validate the project, showing the deployment plan.

This command:

  • Loads and parses SQL files from the project directory
  • Validates the project structure and dependencies
  • Type-checks SQL statements (incremental when possible)
  • Displays the deployment plan including dependencies and SQL statements

Type checking uses compiler-owned incremental artifacts to identify dirty runtime objects. Dependencies are restored lazily, and unchanged builds skip type checking entirely.

§Arguments

  • settings - Resolved project and profile configuration
  • show_progress - If true, displays progress indicators during compilation

§Returns

Compiled planned project ready for deployment

§Errors

Returns CliError::Project if compilation or validation fails