FilterCandidateBuilder

Struct FilterCandidateBuilder 

Source
struct FilterCandidateBuilder {
    expr: Arc<dyn PhysicalExpr>,
    file_schema: SchemaRef,
    table_schema: SchemaRef,
    schema_adapter_factory: Arc<dyn SchemaAdapterFactory>,
}
Expand description

Helper to build a FilterCandidate.

This will do several things

  1. Determine the columns required to evaluate the expression
  2. Calculate data required to estimate the cost of evaluating the filter
  3. Rewrite column expressions in the predicate which reference columns not in the particular file schema.

§Schema Rewrite

When parquet files are read in the context of “schema evolution” there are potentially wo schemas:

  1. The table schema (the columns of the table that the parquet file is part of)
  2. The file schema (the columns actually in the parquet file)

There are times when the table schema contains columns that are not in the file schema, such as when new columns have been added in new parquet files but old files do not have the columns.

When a file is missing a column from the table schema, the value of the missing column is filled in by a SchemaAdapter (by default as NULL).

When a predicate is pushed down to the parquet reader, the predicate is evaluated in the context of the file schema. For each predicate we build a filter schema which is the projection of the table schema that contains only the columns that this filter references. If any columns from the file schema are missing from a particular file they are added by the SchemaAdapter, by default as NULL.

Fields§

§expr: Arc<dyn PhysicalExpr>§file_schema: SchemaRef

The schema of this parquet file. Columns may have different types from the table schema and there may be columns in the file schema that are not in the table schema or columns that are in the table schema that are not in the file schema.

§table_schema: SchemaRef

The schema of the table (merged schema) – columns may be in different order than in the file and have columns that are not in the file schema

§schema_adapter_factory: Arc<dyn SchemaAdapterFactory>

A SchemaAdapterFactory used to map the file schema to the table schema.

Implementations§

Source§

impl FilterCandidateBuilder

Source

pub fn new( expr: Arc<dyn PhysicalExpr>, file_schema: Arc<Schema>, table_schema: Arc<Schema>, schema_adapter_factory: Arc<dyn SchemaAdapterFactory>, ) -> Self

Source

pub fn build( self, metadata: &ParquetMetaData, ) -> Result<Option<FilterCandidate>>

Attempt to build a FilterCandidate from the expression

§Return values
  • Ok(Some(candidate)) if the expression can be used as an ArrowFilter
  • Ok(None) if the expression cannot be used as an ArrowFilter
  • Err(e) if an error occurs while building the candidate

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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