Struct BatchOperationTracker 

pub struct BatchOperationTracker { /* private fields */ }

A tracker for bulk database operations with batch-level progress.

Tracks:

• Batch-level progress (batch X of Y)
• Row-level progress (rows processed / total)
• Error counting with configurable threshold
• Smoothed rate calculation using recent batch times

Rendering Modes

• Rich mode: Two-line display with progress bar, row count, rate, errors
• Plain mode: Single line for agents
• JSON mode: Structured data for programmatic consumption

Example

use sqlmodel_console::renderables::BatchOperationTracker;

let mut tracker = BatchOperationTracker::new("Migrating users", 10, 1000);
tracker.complete_batch(100);
tracker.complete_batch(100);

assert_eq!(tracker.completed_batches(), 2);
assert_eq!(tracker.processed_rows(), 200);

Implementations

impl BatchOperationTracker

pub fn new( operation_name: impl Into<String>, total_batches: u64, total_rows: u64, ) -> Self

Create a new batch operation tracker.

Arguments

• operation_name: Human-readable name for the operation
• total_batches: Total number of batches to process
• total_rows: Total number of rows expected across all batches

pub fn theme(self, theme: Theme) -> Self

Set the theme for styled output.

pub fn error_threshold(self, threshold: u64) -> Self

Set the error threshold for warning state.

When error_count exceeds this threshold, the tracker shows error styling.

pub fn width(self, width: usize) -> Self

Set the rendering width.

pub fn smoothing_window(self, size: usize) -> Self

Set the smoothing window size for rate calculation.

pub fn complete_batch(&mut self, rows_in_batch: u64)

Record completion of a batch.

Arguments

• rows_in_batch: Number of rows processed in this batch

pub fn record_error(&mut self)

Record an error.

pub fn record_errors(&mut self, count: u64)

Record multiple errors.

pub fn operation_name(&self) -> &str

Get the operation name.

pub fn completed_batches(&self) -> u64

Get the number of completed batches.

pub fn total_batches(&self) -> u64

Get the total number of batches.

pub fn processed_rows(&self) -> u64

Get the number of processed rows.

pub fn total_rows(&self) -> u64

Get the total number of rows.

pub fn error_count(&self) -> u64

Get the error count.

pub fn current_state(&self) -> BatchState

Get the current state.

pub fn is_complete(&self) -> bool

Check if the operation is complete.

pub fn batch_percentage(&self) -> f64

Calculate the batch completion percentage.

pub fn row_percentage(&self) -> f64

Calculate the row completion percentage.

pub fn elapsed_secs(&self) -> f64

Calculate the elapsed time in seconds.

pub fn throughput(&self) -> f64

Calculate the smoothed throughput (rows per second).

Uses recent batch times for a more stable rate.

pub fn success_rate(&self) -> f64

Calculate the success rate percentage.

pub fn render_plain(&self) -> String

Render as plain text for agents.

Format: Name: 50% (10/20 batches), 5000/10000 rows, 523 rows/s, 0 errors

pub fn render_styled(&self) -> String

Render with ANSI styling.

Two-line display with progress bar, row count, rate, and errors.

pub fn render_summary(&self) -> String

Render a completion summary.

Shows total time, rows, average rate, error count, and success rate.

pub fn to_json(&self) -> String

Render as JSON for structured output.

Trait Implementations

impl Clone for BatchOperationTracker

fn clone(&self) -> BatchOperationTracker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchOperationTracker

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

Formats the value using the given formatter.