Struct ExplainStatementOptions 

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

Normalized options for a single EXPLAIN statement.

This collects the knobs that can be set per-statement from either the legacy keyword form (EXPLAIN ANALYZE VERBOSE FORMAT tree ...) or the Postgres-style EXPLAIN (option [arg], ...) ... form supported on dialects whose Dialect::supports_explain_with_utility_options returns true.

Fields that are None / false mean “not set at the statement level” — the physical planner falls back to the corresponding session config value.

Fields

analyze: bool

Whether to actually execute the plan and gather metrics.

Corresponds to the ANALYZE keyword or the ANALYZE option.

verbose: bool

Whether to include extra detail in the output.

Corresponds to the VERBOSE keyword or the VERBOSE option.

format: Option<ExplainFormat>

Output format for the plan. When None, the session-config default (datafusion.explain.format) is used.

analyze_level: Option<MetricType>

Override for MetricType (summary / dev) when running EXPLAIN ANALYZE.

analyze_categories: Option<ExplainAnalyzeCategories>

Override for ExplainAnalyzeCategories (rows / bytes / timing / uncategorized) when running EXPLAIN ANALYZE.

show_statistics: Option<bool>

Override for datafusion.explain.show_statistics.

Implementations

impl ExplainStatementOptions

pub fn from_utility_options(opts: &[UtilityOption]) -> Result<Self>

Available on crate feature sql only.

Parse a list of UtilityOption values (produced by sqlparser’s parse_utility_options) into a normalized ExplainStatementOptions.

Argument grammar accepted:

• OPTION — bare, implies TRUE for boolean options.
• OPTION TRUE / OPTION FALSE
• OPTION ON / OPTION OFF
• OPTION 1 / OPTION 0
• OPTION <ident> or OPTION '<string>' for format / level / metrics.

Options recognized by DataFusion are: ANALYZE, VERBOSE, FORMAT, METRICS, LEVEL, TIMING, SUMMARY, COSTS.

Postgres-only options (BUFFERS, WAL, SETTINGS, GENERIC_PLAN, MEMORY) return a helpful “not supported” error. Any other option name produces an unknown EXPLAIN option error.

Trait Implementations

impl Clone for ExplainStatementOptions

fn clone(&self) -> ExplainStatementOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExplainStatementOptions

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

Formats the value using the given formatter.

impl Default for ExplainStatementOptions

fn default() -> ExplainStatementOptions

Returns the “default value” for a type.

impl Eq for ExplainStatementOptions

impl Hash for ExplainStatementOptions

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 ExplainStatementOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExplainStatementOptions