Struct VortexAccessPlan 

pub struct VortexAccessPlan { /* private fields */ }

Additional Vortex-specific scan constraints attached to a PartitionedFile.

VortexAccessPlan is the hook to use when an external index or planner already knows that only part of a file needs to be scanned. The plan is attached as extensions on PartitionedFile, and the internal VortexOpener applies it before building the Vortex scan.

The current access plan surface is intentionally small: it lets callers provide a Selection that narrows the rows considered by the scan.

Example

use vortex_datafusion::VortexAccessPlan;

let file = PartitionedFile::new("metrics.vortex", 1024).with_extensions(Arc::new(
    VortexAccessPlan::default().with_selection(selection),
));

This is a low-level integration point for systems building their own access paths on top of DataFusion. For a conceptually similar Parquet example, see DataFusion’s parquet_advanced_index.

Implementations

impl VortexAccessPlan

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

Sets the row Selection to apply when the file is opened.

impl VortexAccessPlan

pub fn selection(&self) -> Option<&Selection>

Returns the selection, if one was set.

pub fn apply_to_builder<A>( &self, scan_builder: ScanBuilder<A>, ) -> ScanBuilder<A>

where A: 'static + Send,

Applies this access plan to a ScanBuilder.

This is used internally by the file opener after it has translated a PartitionedFile into a Vortex scan.

Trait Implementations

impl Default for VortexAccessPlan

fn default() -> VortexAccessPlan

Returns the “default value” for a type.