Struct PruningPredicateBuilder 

pub struct PruningPredicateBuilder<'a> { /* private fields */ }

Builder for a PruningPredicate. Groups optional configuration — IN (...) rewrite cap, error counter — so future additions do not churn the top-level API.

The two entry points are:

• Self::build: convenience for scan sites that already track a predicate_creation_errors counter. Returns Some(Arc<..>) when the resulting predicate can actually prune, None when it is trivially true or when construction failed (in which case the error counter is incremented if one was supplied).
• Self::try_build: returns a raw Result<PruningPredicate> for callers that want to surface errors themselves.

Implementations

impl<'a> PruningPredicateBuilder<'a>

pub fn new() -> Self

Create a new builder with the default pruning predicate configuration.

pub fn with_file_schema(self, file_schema: SchemaRef) -> Self

Set the schema of the container that will be pruned (typically the parquet file schema).

pub fn with_error_counter(self, error_counter: &'a Count) -> Self

Metric counter incremented once per predicate that fails to build. Only consulted by Self::build; Self::try_build surfaces the error directly.

pub fn with_max_in_list_size(self, max_in_list_size: usize) -> Self

Cap on the size of IN (...) lists that will be rewritten into per- value min/max statistics checks. Lists longer than this fall back to the unhandled-predicate hook (typically “keep the container”).

Query engines typically pass datafusion.execution.parquet.max_in_list_size here.

pub fn build( self, predicate: Arc<dyn PhysicalExpr>, ) -> Option<Arc<PruningPredicate>>

Build a PruningPredicate wrapped in Some(Arc<..>) when it can prune, None when it is trivially true or when construction fails. If Self::with_error_counter was set, construction failures are recorded there.

pub fn try_build( self, predicate: Arc<dyn PhysicalExpr>, ) -> Result<PruningPredicate>

Build a PruningPredicate, returning the construction error directly. Callers that want the always-true predicate elided or errors folded into a counter should use Self::build instead.

Trait Implementations

impl<'a> Default for PruningPredicateBuilder<'a>

fn default() -> PruningPredicateBuilder<'a>

Returns the “default value” for a type.