Enum MetricType 

pub enum MetricType {
    Summary,
    Dev,
}

Categorizes metrics so the display layer can choose the desired verbosity.

The datafusion.explain.analyze_level configuration controls which type is shown:

• "dev" (the default): all metrics are shown.
• "summary": only metrics tagged as Summary are shown.

This is orthogonal to MetricCategory, which filters by what kind of value a metric represents (rows / bytes / timing).

Difference from EXPLAIN ANALYZE VERBOSE

The VERBOSE keyword controls whether per-partition metrics are shown (when specified) or aggregated metrics are displayed (when omitted). In contrast, MetricType determines which levels of metrics are displayed.

Variants

Summary

Common metrics for high-level insights (answering which operator is slow)

Dev

For deep operator-level introspection for developers

Implementations

impl MetricType

pub fn included_types(self) -> Vec<MetricType>

Returns the set of metric types that should be shown for this level.

Dev is a superset of Summary: when the user selects analyze_level = 'dev', both Summary and Dev metrics are shown.

Trait Implementations

impl Clone for MetricType

fn clone(&self) -> MetricType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigField for MetricType

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

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

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

impl Copy for MetricType

impl Debug for MetricType

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

Formats the value using the given formatter.

impl Display for MetricType

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

Formats the value using the given formatter.

impl Eq for MetricType

impl FromStr for MetricType

type Err = DataFusionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MetricType

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 MetricType

fn eq(&self, other: &MetricType) -> 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 MetricType