PartitionPruningStatistics

Struct PartitionPruningStatistics 

Source
pub struct PartitionPruningStatistics { /* private fields */ }
๐Ÿ‘ŽDeprecated since 52.0.0: This struct is no longer used internally. Use replace_columns_with_literals from datafusion-physical-expr-adapter to substitute partition column values before pruning. It will be removed in 58.0.0 or 6 months after 52.0.0 is released, whichever comes first.
Expand description

Prune files based on their partition values.

This is used both at planning time and execution time to prune files based on their partition values. This feeds into CompositePruningStatistics to allow pruning with filters that depend both on partition columns and data columns (e.g. WHERE partition_col = data_col).

Implementationsยง

Sourceยง

impl PartitionPruningStatistics

Source

pub fn try_new( partition_values: Vec<Vec<ScalarValue>>, partition_fields: Vec<FieldRef>, ) -> Result<Self, DataFusionError>

Create a new instance of PartitionPruningStatistics.

Args:

  • partition_values: A vector of vectors of ScalarValues. The outer vector represents the containers while the inner vector represents the partition values for each column. Note that this is the opposite of the order of the partition columns in PartitionPruningStatistics::partition_schema.
  • partition_schema: The schema of the partition columns. This must not be the schema of the entire file or table: instead it must only be the schema of the partition columns, in the same order as the values in partition_values.
ยงExample

To create PartitionPruningStatistics for two partition columns a and b, for three containers like this:

ab
12
34
56

let partition_values = vec![
    vec![ScalarValue::from(1i32), ScalarValue::from(2i32)],
    vec![ScalarValue::from(3i32), ScalarValue::from(4i32)],
    vec![ScalarValue::from(5i32), ScalarValue::from(6i32)],
];
let partition_fields = vec![
    Arc::new(Field::new("a", DataType::Int32, false)),
    Arc::new(Field::new("b", DataType::Int32, false)),
];
let partition_stats =
    PartitionPruningStatistics::try_new(partition_values, partition_fields).unwrap();

Trait Implementationsยง

Sourceยง

impl Clone for PartitionPruningStatistics

Sourceยง

fn clone(&self) -> PartitionPruningStatistics

Returns a duplicate of the value. Read more
1.0.0 ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl PruningStatistics for PartitionPruningStatistics

Sourceยง

fn min_values(&self, column: &Column) -> Option<ArrayRef>

Return the minimum values for the named column, if known. Read more
Sourceยง

fn max_values(&self, column: &Column) -> Option<ArrayRef>

Return the maximum values for the named column, if known. Read more
Sourceยง

fn num_containers(&self) -> usize

Return the number of containers (e.g. Row Groups) being pruned with these statistics. Read more
Sourceยง

fn null_counts(&self, _column: &Column) -> Option<ArrayRef>

Return the number of null values for the named column as an UInt64Array Read more
Sourceยง

fn row_counts(&self, _column: &Column) -> Option<ArrayRef>

Return the number of rows for the named column in each container as an UInt64Array. Read more
Sourceยง

fn contained( &self, column: &Column, values: &HashSet<ScalarValue>, ) -> Option<BooleanArray>

Returns BooleanArray where each row represents information known about specific literal values in a column. 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> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Sourceยง

type Output = T

Should always be Self
Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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> ErasedDestructor for T
where T: 'static,