Struct datafusion_common::config::AggregateOptions

#[non_exhaustive]
pub struct AggregateOptions {
    pub scalar_update_factor: usize,
}

Options related to aggregate execution

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

scalar_update_factor: usize

Specifies the threshold for using ScalarValues to update accumulators during high-cardinality aggregations for each input batch.

The aggregation is considered high-cardinality if the number of affected groups is greater than or equal to batch_size / scalar_update_factor. In such cases, ScalarValues are utilized for updating accumulators, rather than the default batch-slice approach. This can lead to performance improvements.

By adjusting the scalar_update_factor, you can balance the trade-off between more efficient accumulator updates and the number of groups affected.

Trait Implementations

impl Clone for AggregateOptions

fn clone(&self) -> AggregateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AggregateOptions

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

Formats the value using the given formatter.

impl Default for AggregateOptions

fn default() -> Self

Returns the “default value” for a type.