Module explain

EXPLAIN support for various intermediate representations.

Ideally, the EXPLAIN support for each IR should be in the crate where this IR is defined. However, we need to resort to an Explainable newtype struct in order to provide alternate mz_repr::explain::Explain implementations for some structs (see the mir) module for details.

Modules

• fast_path 🔒
  EXPLAIN support for FastPathPlan.
• hir 🔒
  EXPLAIN support for HIR structures.
• insights 🔒
  Derive insights for plans.
• lir 🔒
  EXPLAIN support for LIR structures.
• mir 🔒
  EXPLAIN support for MIR structures.
• optimizer_trace 🔒
  Tracing utilities for explainable plans.

Structs

• Explainable 🔒
  Newtype struct for wrapping types that should implement the mz_repr::explain::Explain trait.

Functions

• explain_dataflow 🔒
  Convenience method to derive an ExplainContext from the index_imports in the given plan and all other input parameters, wrap the plan in an Explainable, and finally compute and return the explain(...) result.
• explain_plan 🔒
  Convenience method to explain a single plan.