Enum ArrowReaderMetrics

pub enum ArrowReaderMetrics {
    Disabled,
    Enabled(Arc<ArrowReaderMetricsInner>),
}

This enum represents the state of Arrow reader metrics collection.

The inner metrics are stored in an Arc<ArrowReaderMetricsInner> so cloning the ArrowReaderMetrics enum will not clone the inner metrics.

To access metrics, create an ArrowReaderMetrics via ArrowReaderMetrics::enabled() and configure the ArrowReaderBuilder with a clone.

Variants

Disabled

Metrics are not collected (default)

Enabled(Arc<ArrowReaderMetricsInner>)

Metrics are collected and stored in an Arc.

Create this via ArrowReaderMetrics::enabled().

Implementations

impl ArrowReaderMetrics

pub fn disabled() -> Self

Creates a new instance of ArrowReaderMetrics::Disabled

pub fn enabled() -> Self

Creates a new instance of ArrowReaderMetrics::Enabled

pub fn records_read_from_inner(&self) -> Option<usize>

Predicate Cache: number of records read directly from the inner reader

This is the total number of records read from the inner reader (that is actually decoding). It measures the amount of work that could not be avoided with caching.

It returns the number of records read across all columns, so if you read 2 columns each with 100 records, this will return 200.

Returns None if metrics are disabled.

pub fn records_read_from_cache(&self) -> Option<usize>

Predicate Cache: number of records read from the cache

This is the total number of records read from the cache actually decoding). It measures the amount of work that was avoided with caching.

It returns the number of records read across all columns, so if you read 2 columns each with 100 records from the cache, this will return 200.

Returns None if metrics are disabled.

pub(crate) fn increment_inner_reads(&self, count: usize)

Increments the count of records read from the inner reader

pub(crate) fn increment_cache_reads(&self, count: usize)

Increments the count of records read from the cache

Trait Implementations

impl Clone for ArrowReaderMetrics

fn clone(&self) -> ArrowReaderMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArrowReaderMetrics

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

Formats the value using the given formatter.