Struct Plan 

pub struct Plan<V: PlanVTable> { /* private fields */ }

A typed, shared handle to a plan operator.

Implementations

impl Plan<Synthetic>

pub fn new( dtype: DType, row_count: u64, children: Vec<PlanRef>, builder: impl Fn(Range<u64>, &Mask, &mut Compiler<'_>) -> VortexResult<Option<Chain>> + Send + Sync + 'static, ) -> Self

A plan of row_count rows of dtype, with children, compiled by builder.

impl Plan<Concat>

pub fn try_new(dtype: DType, children: Vec<PlanRef>) -> VortexResult<Self>

Creates a concatenation over children.

Every child must produce dtype, and the row domain is the sum of the child row counts.

pub fn row_offsets(&self) -> &[u64]

Returns the first row of each child within this plan’s row domain.

impl Plan<Eval>

pub fn try_new( expression: BoundExpression, child: PlanRef, ) -> VortexResult<Self>

Creates an evaluation of expression, which must be bound to the child’s dtype.

pub unsafe fn new_unchecked(expression: BoundExpression, child: PlanRef) -> Self

Creates an evaluation without validating the expression’s root dtype.

Safety

Every scope root in expression must have the same dtype as child.

pub fn expression(&self) -> &BoundExpression

Returns the expression evaluated by this plan.

pub fn child_plan(&self) -> VortexResult<PlanRef>

Returns the child plan supplying the expression root.

impl Plan<Filter>

pub fn new(child: PlanRef) -> Self

Creates a filter over child.

pub fn child_plan(&self) -> VortexResult<PlanRef>

Returns the plan whose rows are filtered.

impl Plan<LegacyStats>

pub fn new( data: PlanRef, zones: PlanRef, zone_len: u64, stats: Arc<[Stat]>, ) -> Self

Creates a legacy stats plan over data summarised by zones of zone_len rows each, whose fields hold stats.

pub fn zone_len(&self) -> u64

Returns the number of rows each zone summarises.

pub fn stats(&self) -> &Arc<[Stat]>

Returns the stats the zone table stores.

pub fn data_plan(&self) -> VortexResult<PlanRef>

Returns the plan producing the summarised data.

pub fn zones_plan(&self) -> VortexResult<PlanRef>

Returns the plan producing the legacy zone table.

impl Plan<ListPack>

pub fn try_new( nullability: Nullability, row_count: u64, elements: PlanRef, offsets: PlanRef, validity: Option<PlanRef>, ) -> VortexResult<Self>

Creates a list assembly from elements and offsets.

validity is required exactly when nullability is Nullability::Nullable. The row domain is one fewer than the number of offsets.

pub fn elements(&self) -> VortexResult<PlanRef>

Returns the plan producing list elements.

pub fn offsets(&self) -> VortexResult<PlanRef>

Returns the plan producing list offsets.

pub fn validity(&self) -> VortexResult<Option<PlanRef>>

Returns the plan producing list validity, if the list is nullable.

impl Plan<Pack>

pub fn try_new( fields: StructFields, nullability: Nullability, row_count: u64, field_plans: Vec<PlanRef>, validity: Option<PlanRef>, ) -> VortexResult<Self>

Creates a struct assembly from fields and one child per field.

Each field child must have the corresponding field dtype and row_count rows. validity is required exactly when nullability is Nullability::Nullable and must produce non-nullable booleans with row_count rows.

pub unsafe fn new_unchecked( fields: StructFields, nullability: Nullability, row_count: u64, field_plans: Vec<PlanRef>, validity: Option<PlanRef>, ) -> Self

Creates a struct assembly without validating its children.

Safety

The caller must ensure that:

• field_plans contains exactly one child per field, in field order;
• every field child has the corresponding field dtype and row_count rows; and
• validity is present exactly when the struct is nullable and, when present, produces non-nullable booleans with row_count rows.

pub fn fields(&self) -> &StructFields

Returns the struct fields assembled by this plan.

pub fn nfields(&self) -> usize

Returns the number of struct fields, excluding any validity child.

pub fn validity(&self) -> VortexResult<Option<PlanRef>>

Returns the plan producing struct validity, if the struct is nullable.

impl Plan<RowIdx>

pub fn new(row_count: u64) -> Self

Creates a row-index source covering row_count rows.

impl Plan<SegmentScan>

pub fn new( dtype: DType, row_count: u64, segment_id: SegmentId, array_ctx: ReadContext, array_tree: Option<ByteBuffer>, ) -> Self

Creates a segment scan over segment_id.

pub fn segment_id(&self) -> SegmentId

Returns the segment this plan reads.

pub fn array_ctx(&self) -> &ReadContext

Returns the read context for the serialized array.

pub fn array_tree(&self) -> Option<&ByteBuffer>

Returns the serialized array encoding tree, when it is stored out of line.

impl Plan<Share>

pub fn new(child: PlanRef) -> Self

Creates a share of child.

pub fn child_plan(&self) -> VortexResult<PlanRef>

Returns the shared plan.

impl Plan<Take>

pub fn new(codes: PlanRef, values: PlanRef) -> Self

Creates a take of values at codes.

The row domain is that of codes, and the output dtype is that of values.

pub fn codes(&self) -> VortexResult<PlanRef>

Returns the plan producing indices.

pub fn values(&self) -> VortexResult<PlanRef>

Returns the plan producing the values being indexed.

impl Plan<Zoned>

pub fn new( data: PlanRef, zones: PlanRef, zone_len: u64, aggregate_fns: Arc<[AggregateFnRef]>, ) -> Self

Creates a zoned plan over data summarised by zones of zone_len rows each, whose fields hold the results of aggregate_fns.

pub fn zone_len(&self) -> u64

Returns the number of rows each zone summarises.

pub fn aggregate_fns(&self) -> &Arc<[AggregateFnRef]>

Returns the aggregate functions whose results the zone table stores.

pub fn pruning_column_dtype(&self) -> Option<&DType>

Returns the dtype of the column the zones summarise, when this is a pruning plan.

pub fn data_plan(&self) -> VortexResult<Option<PlanRef>>

Returns the plan producing the summarised data, unless this is a pruning plan.

pub fn zones_plan(&self) -> VortexResult<PlanRef>

Returns the plan producing the zone statistics.

pub fn is_pruning(&self) -> bool

Returns whether this plan represents a zone-backed pruning proof.

pub fn pruning_expression(&self) -> Option<&BoundExpression>

Returns the abstract pruning proof carried by this plan, when present.

impl<V: PlanVTable> Plan<V>

pub fn from_parts(parts: PlanParts<V>) -> Self

Constructs a plan from explicit parts.

pub fn vtable(&self) -> &V

Returns the vtable.

pub fn data(&self) -> &V::PlanData

Returns operator-specific data.

pub fn dtype(&self) -> &DType

Returns the dtype produced by this plan.

pub fn row_count(&self) -> u64

Returns the number of rows in this plan’s row domain.

pub fn children(&self) -> &PlanChildren

Returns the common child container without initializing any child.

pub fn child(&self, index: usize) -> VortexResult<Option<PlanRef>>

Returns a child, initializing it on first access.

pub fn child_required(&self, index: usize) -> VortexResult<PlanRef>

Returns the child at index, or an error when the index is out of bounds.

pub fn to_plan(&self) -> PlanRef

Erases this typed plan into a shared reference.

pub fn into_plan(self) -> PlanRef

Erases this typed plan into a shared reference.

Trait Implementations

impl<V: PlanVTable> Clone for Plan<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: PlanVTable> Debug for Plan<V>

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<V: PlanVTable> Deref for Plan<V>

type Target = <V as PlanVTable>::PlanData

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<V: PlanVTable> Display for Plan<V>

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<V: PlanVTable> From<Plan<V>> for PlanRef

fn from(value: Plan<V>) -> Self

Converts to this type from the input type.