pub(crate) struct ReadPlanBuilder {
batch_size: usize,
selection: Option<RowSelection>,
}
Expand description
A builder for ReadPlan
Fields§
§batch_size: usize
§selection: Option<RowSelection>
Current to apply, includes all filters
Implementations§
Source§impl ReadPlanBuilder
impl ReadPlanBuilder
Sourcepub(crate) fn new(batch_size: usize) -> Self
pub(crate) fn new(batch_size: usize) -> Self
Create a ReadPlanBuilder
with the given batch size
Sourcepub(crate) fn with_selection(self, selection: Option<RowSelection>) -> Self
pub(crate) fn with_selection(self, selection: Option<RowSelection>) -> Self
Set the current selection to the given value
Sourcepub(crate) fn selection(&self) -> Option<&RowSelection>
pub(crate) fn selection(&self) -> Option<&RowSelection>
Returns the current selection, if any
Sourcepub(crate) fn limited(self, row_count: usize) -> LimitedReadPlanBuilder
pub(crate) fn limited(self, row_count: usize) -> LimitedReadPlanBuilder
Specifies the number of rows in the row group, before filtering is applied.
Returns a LimitedReadPlanBuilder
that can apply
offset and limit.
Call LimitedReadPlanBuilder::build_limited
to apply the limits to this
selection.
Sourcepub(crate) fn selects_any(&self) -> bool
pub(crate) fn selects_any(&self) -> bool
Returns true if the current plan selects any rows
Sourcepub(crate) fn num_rows_selected(&self) -> Option<usize>
pub(crate) fn num_rows_selected(&self) -> Option<usize>
Returns the number of rows selected, or None
if all rows are selected.
Sourcepub(crate) fn with_predicate(
self,
array_reader: Box<dyn ArrayReader>,
predicate: &mut dyn ArrowPredicate,
) -> Result<Self>
pub(crate) fn with_predicate( self, array_reader: Box<dyn ArrayReader>, predicate: &mut dyn ArrowPredicate, ) -> Result<Self>
Evaluates an ArrowPredicate
, updating this plan’s selection
If the current selection
is Some
, the resulting RowSelection
will be the conjunction of the existing selection and the rows selected
by predicate
.
Note: pre-existing selections may come from evaluating a previous predicate
or if the ParquetRecordBatchReader
specified an explicit
RowSelection
in addition to one or more predicates.
Trait Implementations§
Source§impl Clone for ReadPlanBuilder
impl Clone for ReadPlanBuilder
Source§fn clone(&self) -> ReadPlanBuilder
fn clone(&self) -> ReadPlanBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ReadPlanBuilder
impl RefUnwindSafe for ReadPlanBuilder
impl Send for ReadPlanBuilder
impl Sync for ReadPlanBuilder
impl Unpin for ReadPlanBuilder
impl UnwindSafe for ReadPlanBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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