Struct RangePartitioning 

pub struct RangePartitioning { /* private fields */ }

Physical range partitioning.

RangePartitioning describes an ordered key space with split points.

• ordering defines the partitioning key and ordering.
• split_points define the boundaries between adjacent partitions.

Comparisons use the lexicographic order defined by ordering, including ASC/DESC and null ordering. Split points must be strictly ordered according to that ordering, and each split point must have one value per ordering expression. See SplitPoint for the shared boundary convention.

Like other user-specified data properties such as sortedness, if a source declares range partitioning, it is responsible for placing each row in the partition described by the split points. DataFusion will not validate this is upheld.

For a single range key:

ordering = [date ASC NULLS LAST]
split_points = [
  (2022-01-01),
  (2023-01-01),
]

partition 0: date before 2022-01-01
partition 1: date between 2022-01-01 (inclusive) and 2023-01-01 (exclusive)
partition 2: date at/after 2023-01-01

The same model extends to compound keys. For ordering = [time ASC, city ASC], split points are ordered lexicographically by (time, city):

ordering = [time ASC NULLS LAST, city ASC NULLS LAST]
split_points = [
  (2022, Allston),
  (2023, Allston),
]

partition 0: keys before  (2022, Allston)
partition 1: keys between (2022, Allston) and (2023, Allston)
partition 2: keys at/after (2023, Allston)

NOTE: Optimizer and execution behavior for this partitioning is intentionally not implemented and will be introduced incrementally. See https://github.com/apache/datafusion/issues/22395.

Implementations

impl RangePartitioning

pub fn new(ordering: LexOrdering, split_points: Vec<SplitPoint>) -> Self

Creates range partitioning metadata without validating split points.

Use Self::try_new to validate the contract documented on RangePartitioning.

pub fn try_new( ordering: LexOrdering, split_points: Vec<SplitPoint>, ) -> Result<Self>

Creates range partitioning metadata and validates split point shape and ordering.

pub fn ordering(&self) -> &LexOrdering

Returns the ordering that defines the range key.

pub fn split_points(&self) -> &[SplitPoint]

Returns the ordered split points between partitions.

pub fn partition_count(&self) -> usize

Returns the number of partitions.

Trait Implementations

impl Clone for RangePartitioning

fn clone(&self) -> RangePartitioning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RangePartitioning

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

Formats the value using the given formatter.

impl Display for RangePartitioning

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

Formats the value using the given formatter.

impl PartialEq for RangePartitioning

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RangePartitioning