Struct ExplainConfig

pub struct ExplainConfig {

    pub subtree_size: bool,
    pub arity: bool,
    pub types: bool,
    pub keys: bool,
    pub non_negative: bool,
    pub cardinality: bool,
    pub column_names: bool,
    pub equivalences: bool,
    pub join_impls: bool,
    pub humanized_exprs: bool,
    pub linear_chains: bool,
    pub no_fast_path: bool,
    pub no_notices: bool,
    pub node_ids: bool,
    pub raw_plans: bool,
    pub raw_syntax: bool,
    pub redacted: bool,
    pub timing: bool,
    pub filter_pushdown: bool,
    pub features: OptimizerFeatureOverrides,
}

A set of options for controlling the output of Explain implementations.

Fields

subtree_size: bool

Show the SubtreeSize Analysis in the explanation.

arity: bool

Show the number of columns, i.e., the Arity Analysis.

types: bool

Show the types, i.e., the RelationType Analysis.

keys: bool

Show the sets of unique keys, i.e., the UniqueKeys Analysis.

non_negative: bool

Show the NonNegative Analysis.

cardinality: bool

Show the Cardinality Analysis.

column_names: bool

Show the ColumnNames Analysis.

equivalences: bool

Show the Equivalences Analysis.

join_impls: bool

Render implemented MIR Join nodes in a way which reflects the implementation.

humanized_exprs: bool

Use inferred column names when rendering scalar and aggregate expressions.

linear_chains: bool

Restrict output trees to linear chains. Ignored if raw_plans is set.

no_fast_path: bool

Show the slow path plan even if a fast path plan was created. Useful for debugging. Enforced if timing is set.

no_notices: bool

Don’t print optimizer hints.

node_ids: bool

Show node IDs in physical plans.

raw_plans: bool

Don’t normalize plans before explaining them.

raw_syntax: bool

Disable virtual syntax in the explanation.

redacted: bool

Anonymize literals in the plan.

timing: bool

Print optimization timings.

filter_pushdown: bool

Show MFP pushdown information.

features: OptimizerFeatureOverrides

Optimizer feature flags.

Implementations

impl ExplainConfig

pub fn requires_analyses(&self) -> bool

Trait Implementations

impl Clone for ExplainConfig

fn clone(&self) -> ExplainConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainConfig

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

Formats the value using the given formatter.

impl Default for ExplainConfig

fn default() -> Self

Returns the “default value” for a type.