datafusion_physical_plan::aggregates::order

Struct GroupOrderingFull

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

Tracks grouping state when the data is ordered entirely by its group keys

When the group values are sorted, as soon as we see group n+1 we know we will never see any rows for group n again and thus they can be emitted.

For example, given SUM(amt) GROUP BY id if the input is sorted by id as soon as a new id value is seen all previous values can be emitted.

The state is tracked like this:

     ┌─────┐   ┌──────────────────┐
     │┌───┐│   │ ┌──────────────┐ │         ┏━━━━━━━━━━━━━━┓
     ││ 0 ││   │ │     123      │ │   ┌─────┃      13      ┃
     │└───┘│   │ └──────────────┘ │   │     ┗━━━━━━━━━━━━━━┛
     │ ... │   │    ...           │   │
     │┌───┐│   │ ┌──────────────┐ │   │         current
     ││12 ││   │ │     234      │ │   │
     │├───┤│   │ ├──────────────┤ │   │
     ││12 ││   │ │     234      │ │   │
     │├───┤│   │ ├──────────────┤ │   │
     ││13 ││   │ │     456      │◀┼───┘
     │└───┘│   │ └──────────────┘ │
     └─────┘   └──────────────────┘

 group indices    group_values        current tracks the most
(in group value                          recent group index
     order)

In this diagram, the current group is 13, and thus groups 0..12 can be emitted. Note that 13 can not yet be emitted as there may be more values in the next batch with the same group_id.

Implementations§

Source§

impl GroupOrderingFull

Source

pub fn new() -> Self

Source

pub fn emit_to(&self) -> Option<EmitTo>

Source

pub fn remove_groups(&mut self, n: usize)

remove the first n groups from the internal state, shifting all existing indexes down by n

Source

pub fn input_done(&mut self)

Note that the input is complete so any outstanding groups are done as well

Source

pub fn new_groups(&mut self, total_num_groups: usize)

Called when new groups are added in a batch. See documentation on super::GroupOrdering::new_groups

Trait Implementations§

Source§

impl Debug for GroupOrderingFull

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GroupOrderingFull

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, 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, 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> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

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

Source§

impl<T> MaybeSendSync for T