Struct mz_adapter::explain_new::optimizer_trace::OptimizerTrace

pub(crate) struct OptimizerTrace(Dispatch);

Provides functionality for tracing plans generated by the execution of an optimization pipeline.

Internally, this will create a layered tracing::subscriber::Subscriber consisting of one layer for each supported plan type T.

The OptimizerTrace::collect_trace method on the created instance can be then used to collect the trace, and OptimizerTrace::drain_all to obtain the collected trace as a vector of TraceEntry instances.

Tuple Fields

0: Dispatch

Implementations

impl OptimizerTrace

pub fn new() -> OptimizerTrace

Create a new OptimizerTrace.

pub fn find(path: &'static str) -> OptimizerTrace

Create a new OptimizerTrace that will only accumulate TraceEntry instances along the prefix of the given path.

pub fn collect_trace<T>(&self, pipeline: impl FnOnce() -> T) -> T

Run the given optimization pipeline once and collect a trace of all plans produced during that run.

pub fn drain_all(
    self,
    format: ExplainFormat,
    config: ExplainConfig,
    catalog: ConnCatalog<'_>,
    row_set_finishing: Option<RowSetFinishing>,
    used_indexes: Vec<GlobalId>,
    fast_path_plan: Option<FastPathPlan>
) -> Result<Vec<TraceEntry<String>>, ExplainError>

Collect all traced plans for all plan types T that are available in the wrapped dispatcher::Dispatch.

fn drain_explainable_entries<T>(
    &self,
    format: &ExplainFormat,
    context: &ExplainContext<'_>,
    fast_path_plan: &Option<String>
) -> Result<Vec<TraceEntry<String>>, ExplainError>where
    T: Clone + Debug + 'static,
    for<'a> Explainable<'a, T>: Explain<'a, Context = ExplainContext<'a>>,

Collect all trace entries of a plan type T that implements Explainable.

fn drain_scalar_entries<T>(&self) -> Vec<TraceEntry<String>> where
    T: Clone + Debug + 'static + DisplayText,

Collect all trace entries of a plan type T.

fn drain_string_entries(&self) -> Vec<TraceEntry<String>>

Collect all trace entries with plans of type String.