Struct ExplainOptions 

pub struct ExplainOptions {
    pub logical_plan_only: bool,
    pub physical_plan_only: bool,
    pub show_statistics: bool,
    pub show_sizes: bool,
    pub show_schema: bool,
    pub format: ExplainFormat,
    pub tree_maximum_render_width: usize,
    pub analyze_level: MetricType,
    pub analyze_categories: ExplainAnalyzeCategories,
}

Options controlling explain output

See also: SessionConfig

Fields

logical_plan_only: bool

When set to true, the explain statement will only print logical plans

physical_plan_only: bool

When set to true, the explain statement will only print physical plans

show_statistics: bool

When set to true, the explain statement will print operator statistics for physical plans

show_sizes: bool

When set to true, the explain statement will print the partition sizes

show_schema: bool

When set to true, the explain statement will print schema information

format: ExplainFormat

Display format of explain. Default is “indent”. When set to “tree”, it will print the plan in a tree-rendered format.

tree_maximum_render_width: usize

(format=tree only) Maximum total width of the rendered tree. When set to 0, the tree will have no width limit.

analyze_level: MetricType

Verbosity level for “EXPLAIN ANALYZE”. Default is “dev” “summary” shows common metrics for high-level insights. “dev” provides deep operator-level introspection for developers.

analyze_categories: ExplainAnalyzeCategories

Which metric categories to include in “EXPLAIN ANALYZE” output. Comma-separated list of: “rows”, “bytes”, “timing”, “uncategorized”. Use “none” to show plan structure only, or “all” (default) to show everything. Metrics without a declared category are treated as “uncategorized”.

Trait Implementations

impl Clone for ExplainOptions

fn clone(&self) -> ExplainOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigField for ExplainOptions

fn set(&mut self, key: &str, value: &str) -> Result<()>

fn visit<V: Visit>( &self, v: &mut V, key_prefix: &str, _description: &'static str, )

fn reset(&mut self, key: &str) -> Result<()>

impl Debug for ExplainOptions

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

Formats the value using the given formatter.

impl Default for ExplainOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ExplainOptions

fn eq(&self, other: &ExplainOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExplainOptions