Struct datafusion_physical_plan::sorts::RowIndex

pub struct RowIndex {
    pub stream_idx: usize,
    pub batch_idx: usize,
    pub row_idx: usize,
}

A RowIndex identifies a specific row in a logical stream.

Each stream is identified by an stream_idx and is formed from a sequence of RecordBatches batches, each of which is identified by a unique batch_idx within that stream.

This is used by SortPreservingMergeStream to identify which the order of the tuples in the final sorted output stream.

┌────┐ ┌────┐ ┌────┐           RecordBatch
│    │ │    │ │    │
│ C1 │ │... │ │ CN │◀─────── (batch_idx = 0)
│    │ │    │ │    │
└────┘ └────┘ └────┘
┌────┐ ┌────┐ ┌────┐           RecordBatch
│    │ │    │ │    │
│ C1 │ │... │ │ CN │◀─────── (batch_idx = 1)
│    │ │    │ │    │
└────┘ └────┘ └────┘
┌────┐
│    │         ...
│ C1 │
│    │        ┌────┐           RecordBatch
└────┘        │    │
              │ CN │◀────── (batch_idx = M-1)
              │    │
              └────┘

"Stream"s each with           Stream N has M
  a potentially              RecordBatches
different number of
  RecordBatches

Fields

stream_idx: usize

The index of the stream (uniquely identifies the stream)

batch_idx: usize

The index of the batch within the stream’s VecDequeue.

row_idx: usize

The row index within the batch

Trait Implementations

impl Clone for RowIndex

fn clone(&self) -> RowIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RowIndex

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

Formats the value using the given formatter.