Struct CompletenessAnalyzer 

pub struct CompletenessAnalyzer { /* private fields */ }

Analyzer that computes the fraction of non-null values for a column.

Completeness is a fundamental data quality metric that measures how much of the expected data is actually present.

Example

use term_guard::analyzers::basic::CompletenessAnalyzer;
use datafusion::prelude::*;

let ctx = SessionContext::new();
// Register your data table

let analyzer = CompletenessAnalyzer::new("user_id");
let state = analyzer.compute_state_from_data(&ctx).await?;
let metric = analyzer.compute_metric_from_state(&state)?;

if let MetricValue::Double(completeness) = metric {
    println!("Column completeness: {:.2}%", completeness * 100.0);
}

Implementations

impl CompletenessAnalyzer

pub fn new(column: impl Into<String>) -> Self

Creates a new completeness analyzer for the specified column.

pub fn column(&self) -> &str

Returns the column being analyzed.

Trait Implementations

impl Analyzer for CompletenessAnalyzer

type State = CompletenessState

The state type for incremental computation.

type Metric = MetricValue

The metric type produced by this analyzer.

fn compute_state_from_data<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = AnalyzerResult<Self::State>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Computes the state from the input data.

fn compute_metric_from_state( &self, state: &Self::State, ) -> AnalyzerResult<Self::Metric>

Computes the final metric from the accumulated state.

fn name(&self) -> &str

Returns the name of this analyzer.

fn description(&self) -> &str

Returns a description of what this analyzer computes.

fn metric_key(&self) -> String

Returns the metric key for storing results.

fn columns(&self) -> Vec<&str>

Returns the column(s) this analyzer operates on, if any.

fn merge_states(&self, states: Vec<Self::State>) -> AnalyzerResult<Self::State>

Merges multiple states into a single state.

fn is_combinable(&self) -> bool

Indicates whether this analyzer can be combined with others.

impl Clone for CompletenessAnalyzer

fn clone(&self) -> CompletenessAnalyzer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletenessAnalyzer

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

Formats the value using the given formatter.

impl GroupedAnalyzer for CompletenessAnalyzer

type GroupedState = GroupedCompletenessState

The grouped state type for this analyzer.

fn compute_grouped_state_from_data<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 SessionContext, config: &'life2 GroupingConfig, ) -> Pin<Box<dyn Future<Output = AnalyzerResult<Self::GroupedState>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Computes grouped state from data.

fn compute_grouped_metrics_from_state( &self, state: &Self::GroupedState, ) -> AnalyzerResult<GroupedMetrics>

Computes metrics from grouped state.

fn with_grouping(self, config: GroupingConfig) -> GroupedAnalyzerWrapper<Self>

where Self: Sized + 'static,

Configures grouping for this analyzer.