Struct ScanBuilder

pub struct ScanBuilder { /* private fields */ }

A struct for building a scan operation.

Implementations

impl ScanBuilder

pub fn new(layout_reader: Arc<dyn LayoutReader>) -> ScanBuilder

pub fn with_filter(self, filter: Arc<dyn VortexExpr>) -> ScanBuilder

pub fn with_some_filter( self, filter: Option<Arc<dyn VortexExpr>>, ) -> ScanBuilder

pub fn with_projection(self, projection: Arc<dyn VortexExpr>) -> ScanBuilder

pub fn with_row_range(self, row_range: Range<u64>) -> ScanBuilder

pub fn with_some_row_range(self, row_range: Option<Range<u64>>) -> ScanBuilder

pub fn with_selection(self, selection: Selection) -> ScanBuilder

pub fn with_row_indices(self, row_indices: Buffer<u64>) -> ScanBuilder

pub fn with_split_by(self, split_by: SplitBy) -> ScanBuilder

pub fn with_canonicalize(self, canonicalize: bool) -> ScanBuilder

Set whether the scan should canonicalize the output.

pub fn with_concurrency(self, concurrency: usize) -> ScanBuilder

The number of row splits to make progress on concurrently, must be greater than 0.

pub fn with_metrics(self, metrics: VortexMetrics) -> ScanBuilder

pub fn spawn_on<F, S>( self, spawner: S, ) -> Result<impl ArrayStream + 'static, VortexError>

where F: Future<Output = Result<Option<Arc<dyn Array>>, VortexError>>, S: FnMut(Pin<Box<dyn Future<Output = Result<Option<Arc<dyn Array>>, VortexError>> + Send>>) -> F + 'static,

Returns a stream over the scan with each CPU task spawned using the given spawn function.

pub fn into_array_stream( self, ) -> Result<impl ArrayStream + 'static, VortexError>

Returns a stream over the scan with each CPU task polled on the current thread as per the behaviour of futures::stream::Buffered.

pub fn into_array_iter( self, ) -> Result<impl ArrayIterator + 'static, VortexError>

Returns a blocking iterator over the scan.

All work will be performed on the current thread, with tasks interleaved per the configured concurrency.