Skip to main content

Module compile

Module compile 

Source
Expand description

Compile command — validate project and show deployment plan.

Compiles the project through a multi-stage pipeline:

  1. Parse — Load and parse SQL files from the project directory.
  2. Validate — Check project structure and dependencies.
  3. Build graph — Assemble the dependency-aware project graph.
  4. Typecheck — Incrementally validate SQL against Materialize. Only objects whose definitions changed since the last build are re-validated; unchanged builds skip typechecking entirely.
  5. Display — Print the deployment plan with dependencies and SQL.

Functions§

print_cluster_dependencies 🔒
Prints cluster prerequisites inferred from object and index definitions.
print_dependency_graph 🔒
Prints per-object dependency edges for troubleshooting deployment ordering.
print_external_dependencies 🔒
Prints dependencies that are referenced but not declared in this project tree.
print_verbose_details 🔒
Print verbose details about the project (only shown with VERBOSE env var)
run
Compile and validate the project, showing the deployment plan.
run_inner 🔒
run_with_fs 🔒
Like run but uses the provided crate::fs::FileSystem (typically an overlay built from unsaved editor buffers) instead of constructing a disk-only one.
run_without_typecheck
Compile the project without type checking.
typecheck_project 🔒
Perform type checking using the in-process catalog backend.