Printer for the plan, ie: EXPLAIN

Cargo.toml

@@ -153,6 +153,7 @@ enum-as-inner = "0.6"
 enum-map = "2.6.3"
 env_logger = "0.10"
 ethnum = { version = "1.5.0", features = ["serde"] }
+expect-test = "1.5.0"
 flate2 = "1.0.24"
 fs-err = "2.9.0"
 fs2 = "0.4.3"

crates/core/Cargo.toml

@@ -20,6 +20,8 @@ spacetimedb-lib = { workspace = true, features = ["serde", "metrics_impls"] }
 spacetimedb-client-api-messages.workspace = true
 spacetimedb-commitlog.workspace = true
 spacetimedb-durability.workspace = true
+spacetimedb-expr.workspace = true
+spacetimedb-execution.workspace = true
 spacetimedb-metrics.workspace = true
 spacetimedb-primitives.workspace = true
 spacetimedb-paths.workspace = true
@@ -30,8 +32,6 @@ spacetimedb-schema.workspace = true
 spacetimedb-table.workspace = true
 spacetimedb-vm.workspace = true
 spacetimedb-snapshot.workspace = true
-spacetimedb-expr.workspace = true
-spacetimedb-execution.workspace = true
 
 anyhow = { workspace = true, features = ["backtrace"] }
 arrayvec.workspace = true
@@ -50,6 +50,7 @@ derive_more.workspace = true
 dirs.workspace = true
 enum-as-inner.workspace = true
 enum-map.workspace = true
+expect-test.workspace = true
 flate2.workspace = true
 fs2.workspace = true
 futures.workspace = true
@@ -119,6 +120,7 @@ default = ["unindexed_iter_by_col_range_warn"]
 # Enable test helpers and utils
 test = []
 
+
 [dev-dependencies]
 spacetimedb-lib = { path = "../lib", features = ["proptest"] }
 spacetimedb-sats = { path = "../sats", features = ["proptest"] }

crates/expr/src/check.rs

@@ -166,10 +166,12 @@ pub fn type_subscription(ast: SqlSelect, tx: &impl SchemaView) -> TypingResult<P
 
 /// Parse and type check a *subscription* query into a `StatementCtx`
 pub fn compile_sql_sub<'a>(sql: &'a str, tx: &impl SchemaView) -> TypingResult<StatementCtx<'a>> {
+    let planning_time = std::time::Instant::now();
     Ok(StatementCtx {
         statement: Statement::Select(ProjectList::Name(parse_and_type_sub(sql, tx)?)),
         sql,
         source: StatementSource::Subscription,
+        planning_time: planning_time.elapsed(),
     })
 }
 

crates/expr/src/lib.rs

@@ -175,6 +175,7 @@ pub(crate) fn parse(value: String, ty: &AlgebraicType) -> Result<AlgebraicValue,
 }
 
 /// The source of a statement
+#[derive(Debug, Clone, Copy)]
 pub enum StatementSource {
     Subscription,
     Query,
@@ -187,4 +188,5 @@ pub struct StatementCtx<'a> {
     pub statement: Statement,
     pub sql: &'a str,
     pub source: StatementSource,
+    pub planning_time: std::time::Duration,
 }

crates/expr/src/statement.rs

@@ -279,11 +279,13 @@ fn parse_and_type_sql(sql: &str, tx: &impl SchemaView) -> TypingResult<Statement
 
 /// Parse and type check a *general* query into a [StatementCtx].
 pub fn compile_sql_stmt<'a>(sql: &'a str, tx: &impl SchemaView) -> TypingResult<StatementCtx<'a>> {
+    let planning_time = std::time::Instant::now();
     let statement = parse_and_type_sql(sql, tx)?;
     Ok(StatementCtx {
         statement,
         sql,
         source: StatementSource::Query,
+        planning_time: planning_time.elapsed(),
     })
 }
 

crates/physical-plan/Cargo.toml

@@ -9,6 +9,8 @@ description = "The physical query plan for the SpacetimeDB query engine"
 [dependencies]
 anyhow.workspace = true
 derive_more.workspace = true
+expect-test.workspace = true
+itertools.workspace = true
 spacetimedb-lib.workspace = true
 spacetimedb-primitives.workspace = true
 spacetimedb-schema.workspace = true

crates/physical-plan/src/compile.rs

@@ -161,14 +161,12 @@ pub fn compile(ast: StatementCtx<'_>) -> PhysicalCtx<'_> {
             self.next.into()
         }
     }
+    let mut var = Interner {
+        next: 0,
+        names: HashMap::new(),
+    };
     let plan = match ast.statement {
-        Statement::Select(expr) => compile_project_list(
-            &mut Interner {
-                next: 0,
-                names: HashMap::new(),
-            },
-            expr,
-        ),
+        Statement::Select(expr) => compile_project_list(&mut var, expr),
         _ => {
             unreachable!("Only `SELECT` is implemented")
         }
@@ -177,6 +175,8 @@ pub fn compile(ast: StatementCtx<'_>) -> PhysicalCtx<'_> {
     PhysicalCtx {
         plan,
         sql: ast.sql,
+        vars: var.names,
         source: ast.source,
+        planning_time: ast.planning_time,
     }
 }

crates/physical-plan/src/lib.rs

@@ -1,3 +1,4 @@
 pub mod compile;
 pub mod plan;
+pub mod printer;
 pub mod rules;