Struct OutputMetrics 

pub struct OutputMetrics {
    inner: Arc<OutputMetricsInner>,
}

Terminal metrics associated with a query output.

For streaming outputs, metrics are only final after the stream is fully drained and Self::is_ready returns true. Affected-row outputs may briefly await a compatibility trailing metrics message.

Fields

inner: Arc<OutputMetricsInner>

Implementations

impl OutputMetrics

fn new() -> Self

pub fn update(&self, metrics: Option<RecordBatchMetrics>)

Replaces the current terminal metrics snapshot.

pub fn mark_ready(&self)

Marks the terminal metrics as final for this output.

pub async fn wait_ready(&self)

Waits until terminal metrics are final.

pub fn completion_error(&self) -> Option<String>

Returns an error encountered while completing the output, if any.

fn set_completion_error(&self, error: impl Into<String>)

fn set_compatibility_task(&self, handle: AbortHandle)

fn take_compatibility_task(&self) -> Option<AbortHandle>

pub fn is_ready(&self) -> bool

Returns whether terminal metrics are final.

Streaming outputs become ready only after the stream reaches EOF.

pub fn get(&self) -> Option<RecordBatchMetrics>

Returns the latest terminal metrics snapshot, if any.

pub fn region_watermark_map(&self) -> Option<HashMap<u64, u64>>

Returns proved per-region watermarks.

Entries whose watermark is None are intentionally omitted because they represent participating regions whose terminal sequence bound was not provable.

pub fn participating_regions(&self) -> Option<BTreeSet<u64>>

Returns all regions that participated in terminal metric collection, including entries whose watermark is None.

Trait Implementations

impl Clone for OutputMetrics

fn clone(&self) -> OutputMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputMetrics

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

Formats the value using the given formatter.

impl Default for OutputMetrics

fn default() -> OutputMetrics

Returns the “default value” for a type.