AnalysisRunner

Struct AnalysisRunner 

Source
pub struct AnalysisRunner { /* private fields */ }
Expand description

Orchestrates the execution of multiple analyzers on a dataset.

The AnalysisRunner optimizes execution by grouping compatible analyzers that can share computation, minimizing the number of DataFrame scans required.

§Example

use term_guard::analyzers::{AnalysisRunner, basic::*};
use datafusion::prelude::*;

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

let runner = AnalysisRunner::new()
    .add(SizeAnalyzer::new())
    .add(CompletenessAnalyzer::new("user_id"))
    .add(DistinctnessAnalyzer::new("user_id"))
    .on_progress(|progress| {
        println!("Analysis progress: {:.1}%", progress * 100.0);
    });

let context = runner.run(&ctx).await?;
println!("Computed {} metrics", context.all_metrics().len());

Implementations§

Source§

impl AnalysisRunner

Source

pub fn new() -> Self

Creates a new empty AnalysisRunner.

Source

pub fn add<A>(self, analyzer: A) -> Self
where A: Analyzer + 'static, A::Metric: Into<MetricValue> + 'static,

Adds an analyzer to the runner.

§Arguments
  • analyzer - The analyzer to add
§Type Parameters
  • A - The analyzer type that implements the Analyzer trait
Source

pub fn on_progress<F>(self, callback: F) -> Self
where F: Fn(f64) + Send + Sync + 'static,

Sets a progress callback that will be called during execution.

The callback receives a float between 0.0 and 1.0 indicating progress.

Source

pub fn continue_on_error(self, continue_on_error: bool) -> Self

Sets whether to continue execution when individual analyzers fail.

Default is true (continue on error).

Source

pub async fn run(&self, ctx: &SessionContext) -> AnalyzerResult<AnalyzerContext>

Executes all analyzers on the given data context.

This method optimizes execution by grouping compatible analyzers and executing them together when possible.

§Arguments
  • ctx - The DataFusion session context with registered data
§Returns

An AnalyzerContext containing all computed metrics and any errors

Source

pub fn analyzer_count(&self) -> usize

Returns the number of analyzers configured.

Trait Implementations§

Source§

impl Default for AnalysisRunner

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,