Struct ExplainOption 

pub struct ExplainOption {
    pub verbose: bool,
    pub analyze: bool,
    pub format: ExplainFormat,
    pub show_statistics: Option<bool>,
    pub analyze_level: Option<MetricType>,
    pub analyze_categories: Option<ExplainAnalyzeCategories>,
}

Options for EXPLAIN

Fields

verbose: bool

Include detailed debug info

analyze: bool

Actually execute the plan and report metrics

format: ExplainFormat

Output syntax/format

show_statistics: Option<bool>

Statement-level override for datafusion.explain.show_statistics. None means “fall back to session config”.

analyze_level: Option<MetricType>

Statement-level override for datafusion.explain.analyze_level. None means “fall back to session config”.

analyze_categories: Option<ExplainAnalyzeCategories>

Statement-level override for datafusion.explain.analyze_categories. None means “fall back to session config”.

Implementations

impl ExplainOption

pub fn with_verbose(self, verbose: bool) -> Self

Builder‐style setter for verbose

pub fn with_analyze(self, analyze: bool) -> Self

Builder‐style setter for analyze

pub fn with_format(self, format: ExplainFormat) -> Self

Builder‐style setter for format

pub fn with_show_statistics(self, show_statistics: Option<bool>) -> Self

Builder-style setter for a statement-level override of datafusion.explain.show_statistics.

pub fn with_analyze_level(self, analyze_level: Option<MetricType>) -> Self

Builder-style setter for a statement-level override of datafusion.explain.analyze_level.

pub fn with_analyze_categories( self, analyze_categories: Option<ExplainAnalyzeCategories>, ) -> Self

Builder-style setter for a statement-level override of datafusion.explain.analyze_categories.

Trait Implementations

impl Clone for ExplainOption

fn clone(&self) -> ExplainOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainOption

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

Formats the value using the given formatter.

impl Default for ExplainOption

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ExplainOption

impl Hash for ExplainOption

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ExplainOption

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExplainOption