Struct DisplayableExecutionPlan

pub struct DisplayableExecutionPlan<'a> { /* private fields */ }

Wraps an ExecutionPlan with various ways to display this plan

Implementations

impl<'a> DisplayableExecutionPlan<'a>

pub fn new(inner: &'a dyn ExecutionPlan) -> Self

Create a wrapper around an ExecutionPlan which can be pretty printed in a variety of ways

pub fn with_metrics(inner: &'a dyn ExecutionPlan) -> Self

Create a wrapper around an ExecutionPlan which can be pretty printed in a variety of ways that also shows aggregated metrics

pub fn with_full_metrics(inner: &'a dyn ExecutionPlan) -> Self

Create a wrapper around an ExecutionPlan which can be pretty printed in a variety of ways that also shows all low level metrics

pub fn set_show_schema(self, show_schema: bool) -> Self

Enable display of schema

If true, plans will be displayed with schema information at the end of each line. The format is schema=[[a:Int32;N, b:Int32;N, c:Int32;N]]

pub fn set_show_statistics(self, show_statistics: bool) -> Self

Enable display of statistics

pub fn indent(&self, verbose: bool) -> impl Display + 'a

Return a formatable structure that produces a single line per node.

ProjectionExec: expr=[a]
  CoalesceBatchesExec: target_batch_size=8192
    FilterExec: a < 5
      RepartitionExec: partitioning=RoundRobinBatch(16)
        CsvExec: source=...",

pub fn graphviz(&self) -> impl Display + 'a

Returns a formatable structure that produces graphviz format for execution plan, which can be directly visualized here.

An example is

strict digraph dot_plan {

pub fn one_line(&self) -> impl Display + 'a

Return a single-line summary of the root of the plan Example: ProjectionExec: expr=[a@0 as a].

pub fn to_stringified( &self, verbose: bool, plan_type: PlanType, ) -> StringifiedPlan

format as a StringifiedPlan

Trait Implementations

impl<'a> Clone for DisplayableExecutionPlan<'a>

fn clone(&self) -> DisplayableExecutionPlan<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for DisplayableExecutionPlan<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.