Struct datafusion_python::datafusion_common::config::AggregateOptions

pub struct AggregateOptions {
    pub scalar_update_factor: usize,
}

Options related to aggregate execution

See also: SessionConfig

Fields

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 ConfigField for AggregateOptions

fn set(&mut self, key: &str, value: &str) -> Result<(), DataFusionError>

fn visit<V>(&self, v: &mut V, key_prefix: &str, _description: &'static str)

where V: Visit,

impl Debug for AggregateOptions

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

Formats the value using the given formatter.

impl Default for AggregateOptions

fn default() -> AggregateOptions

Returns the “default value” for a type.

impl PartialEq for AggregateOptions

fn eq(&self, other: &AggregateOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AggregateOptions