Struct RegionScanExec 

pub struct RegionScanExec {
    scanner: Arc<Mutex<RegionScannerRef>>,
    arrow_schema: SchemaRef,
    output_ordering: Option<Vec<PhysicalSortExpr>>,
    metric: ExecutionPlanMetricsSet,
    properties: Arc<PlanProperties>,
    append_mode: bool,
    total_rows: usize,
    is_partition_set: bool,
    distribution: Option<TimeSeriesDistribution>,
    explain_verbose: bool,
    query_memory_tracker: Option<QueryMemoryTracker>,
    pushed_dyn_filters: Arc<Mutex<Vec<Arc<dyn PhysicalExpr>>>>,
}

A plan to read multiple partitions from a region of a table.

Fields

scanner: Arc<Mutex<RegionScannerRef>>

arrow_schema: SchemaRef

output_ordering: Option<Vec<PhysicalSortExpr>>

The expected output ordering for the plan.

metric: ExecutionPlanMetricsSet

properties: Arc<PlanProperties>

append_mode: bool

total_rows: usize

is_partition_set: bool

distribution: Option<TimeSeriesDistribution>

explain_verbose: bool

query_memory_tracker: Option<QueryMemoryTracker>

pushed_dyn_filters: Arc<Mutex<Vec<Arc<dyn PhysicalExpr>>>>

Dynamic filters accepted by the scanner and applied to decoded output batches. The wrappers themselves remain live and are updated by their producers.

Implementations

impl RegionScanExec

pub fn new( scanner: RegionScannerRef, request: ScanRequest, query_memory_tracker: Option<QueryMemoryTracker>, ) -> DfResult<Self>

pub fn get_partition_ranges(&self) -> Vec<PartitionRange>

Get the partition ranges of the scanner. This method will collapse the ranges into a single vector.

pub fn get_uncollapsed_partition_ranges(&self) -> Vec<Vec<PartitionRange>>

Similar to Self::get_partition_ranges but don’t collapse the ranges.

pub fn is_partition_set(&self) -> bool

pub fn scanner_type(&self) -> String

pub fn with_new_partitions( &self, partitions: Vec<Vec<PartitionRange>>, target_partitions: usize, ) -> Result<Self, BoxedError>

Update the partition ranges of underlying scanner.

pub fn distribution(&self) -> Option<TimeSeriesDistribution>

pub fn with_distinguish_partition_range( &self, distinguish_partition_range: bool, )

pub fn time_index(&self) -> String

pub fn tag_columns(&self) -> Vec<String>

pub fn set_explain_verbose(&mut self, explain_verbose: bool)

pub fn add_dyn_filters_to_predicate( &self, filter_exprs: Vec<Arc<dyn PhysicalExpr>>, ) -> Vec<bool>

Adds dynamic filters directly to the underlying region scanner predicate.

This is the same mutation path used by DataFusion child-filter pushdown. Remote dynamic filter updates install their shared runtime wrapper through this method at scan build time and later update the wrapper state out-of-band.

pub fn query_load_region_id(&self) -> Option<u64>

pub fn query_stat_counters(&self) -> Option<RegionQueryStatCounters>

Trait Implementations

impl Clone for RegionScanExec

fn clone(&self) -> RegionScanExec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegionScanExec

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

Formats the value using the given formatter.

impl DisplayAs for RegionScanExec

fn fmt_as(&self, t: DisplayFormatType, f: &mut Formatter<'_>) -> Result

Format according to DisplayFormatType, used when verbose representation looks different from the default one

impl ExecutionPlan for RegionScanExec

fn schema(&self) -> ArrowSchemaRef

Get the schema for this execution plan

fn properties(&self) -> &Arc<PlanProperties>

Return properties of the output of the ExecutionPlan, such as output ordering(s), partitioning information etc.

fn children(&self) -> Vec<&Arc<dyn ExecutionPlan>>

Get a list of children ExecutionPlans that act as inputs to this plan. The returned list will be empty for leaf nodes such as scans, will contain a single value for unary nodes, or two values for binary nodes (such as joins).

fn apply_expressions( &self, f: &mut dyn FnMut(&Arc<dyn PhysicalExpr>) -> Result<TreeNodeRecursion>, ) -> Result<TreeNodeRecursion>

Apply a closure f to each root expression that this node owns and uses during execution, either by evaluating it or updating it dynamically.

fn with_new_children( self: Arc<Self>, _children: Vec<Arc<dyn ExecutionPlan>>, ) -> Result<Arc<dyn ExecutionPlan>>

👎Deprecated since 55.0.0:

Use ExecutionPlan::replace_children with ReplaceChildrenOptions

Deprecated.

fn execute( &self, partition: usize, context: Arc<TaskContext>, ) -> Result<DfSendableRecordBatchStream>

Begin execution of partition, returning a Stream of [RecordBatch]es.

fn metrics(&self) -> Option<MetricsSet>

Return a snapshot of the set of [Metric]s for this [ExecutionPlan]. If no Metrics are available, return None.

fn reset_state(self: Arc<Self>) -> DfResult<Arc<dyn ExecutionPlan>>

Reset any internal state within this [ExecutionPlan].

fn statistics_from_inputs( &self, _input_stats: &[Arc<Statistics>], args: &StatisticsArgs, ) -> DfResult<Arc<Statistics>>

Returns statistics for a specific partition of this ExecutionPlan node, given pre-computed child statistics.

fn name(&self) -> &str

Short name for the ExecutionPlan, such as ‘DataSourceExec’.

fn handle_child_pushdown_result( &self, _phase: FilterPushdownPhase, child_pushdown_result: ChildPushdownResult, _config: &ConfigOptions, ) -> DfResult<FilterPushdownPropagation<Arc<dyn ExecutionPlan>>>

Handle the result of a child pushdown.

fn static_name() -> &'static str

where Self: Sized,

Short name for the ExecutionPlan, such as ‘DataSourceExec’. Like name but can be called without an instance.

fn downcast_delegate(&self) -> Option<&(dyn ExecutionPlan + 'static)>

Returns the plan that provides this plan’s public [ExecutionPlan] downcast identity.

fn check_invariants(&self, check: InvariantLevel) -> Result<(), DataFusionError>

Returns an error if this individual node does not conform to its invariants. These invariants are typically only checked in debug mode.

fn dynamic_expressions_produced(&self) -> Vec<Arc<dyn PhysicalExpr>>

Returns the dynamic expressions produced by this plan node.

fn required_input_distribution(&self) -> Vec<Distribution>

👎Deprecated since 55.0.0:

Use input_distribution_requirements

Specifies simple per-child input distribution requirements.

fn input_distribution_requirements(&self) -> InputDistributionRequirements

Specifies the input distribution requirements for this plan.

fn required_input_ordering(&self) -> Vec<Option<OrderingRequirements>>

Specifies the ordering required for all of the children of this ExecutionPlan.

fn maintains_input_order(&self) -> Vec<bool>

Returns false if this ExecutionPlan’s implementation may reorder rows within or between partitions.

fn benefits_from_input_partitioning(&self) -> Vec<bool>

Specifies whether the ExecutionPlan benefits from increased parallelization at its input for each child.

fn replace_children( self: Arc<Self>, children: Vec<Arc<dyn ExecutionPlan>>, options: ReplaceChildrenOptions, ) -> Result<Arc<dyn ExecutionPlan>, DataFusionError>

Returns a clone of the existing plan with the children replaced, skipping recomputation of plan properties when the options indicate the new children’s properties are unchanged.

fn with_new_children_and_same_properties( self: Arc<Self>, children: Vec<Arc<dyn ExecutionPlan>>, ) -> Result<Arc<dyn ExecutionPlan>, DataFusionError>

👎Deprecated since 55.0.0:

Use ExecutionPlan::replace_children with ReplaceChildrenOptions

Deprecated. Implement [ExecutionPlan::replace_children] instead.

fn repartitioned( &self, _target_partitions: usize, _config: &ConfigOptions, ) -> Result<Option<Arc<dyn ExecutionPlan>>, DataFusionError>

If supported, attempt to increase the partitioning of this ExecutionPlan to produce target_partitions partitions.

fn partition_statistics( &self, partition: Option<usize>, ) -> Result<Arc<Statistics>, DataFusionError>

👎Deprecated since 55.0.0:

Use StatisticsContext::compute instead

Returns statistics for a specific partition of this ExecutionPlan node.

fn child_stats_requests(&self, _partition: Option<usize>) -> Vec<ChildStats>

Returns, per child, which statistics the StatisticsContext should resolve before calling [Self::statistics_from_inputs].

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this ExecutionPlan node.

fn with_fetch(&self, _limit: Option<usize>) -> Option<Arc<dyn ExecutionPlan>>

Returns a fetching variant of this ExecutionPlan node, if it supports fetch limits. Returns None otherwise.

fn fetch(&self) -> Option<usize>

Gets the fetch count for the operator, None means there is no fetch.

fn cardinality_effect(&self) -> CardinalityEffect

Gets the effect on cardinality, if known

fn try_swapping_with_projection( &self, _projection: &ProjectionExec, ) -> Result<Option<Arc<dyn ExecutionPlan>>, DataFusionError>

Attempts to push down the given projection into the input of this ExecutionPlan.

fn gather_filters_for_pushdown( &self, _phase: FilterPushdownPhase, parent_filters: Vec<Arc<dyn PhysicalExpr>>, _config: &ConfigOptions, ) -> Result<FilterDescription, DataFusionError>

Collect filters that this node can push down to its children. Filters that are being pushed down from parents are passed in, and the node may generate additional filters to push down. For example, given the plan FilterExec -> HashJoinExec -> DataSourceExec, what will happen is that we recurse down the plan calling ExecutionPlan::gather_filters_for_pushdown:

fn with_new_state( &self, _state: Arc<dyn Any + Send + Sync>, ) -> Option<Arc<dyn ExecutionPlan>>

Injects arbitrary run-time state into this execution plan, returning a new plan instance that incorporates that state if it is relevant to the concrete node implementation.

fn try_pushdown_sort( &self, _order: &[PhysicalSortExpr], ) -> Result<SortOrderPushdownResult<Arc<dyn ExecutionPlan>>, DataFusionError>

Try to push down sort ordering requirements to this node.

fn with_preserve_order( &self, _preserve_order: bool, ) -> Option<Arc<dyn ExecutionPlan>>

Returns a variant of this ExecutionPlan that is aware of order-sensitivity.

fn try_to_proto( &self, _ctx: &ExecutionPlanEncodeCtx<'_>, ) -> Result<Option<PhysicalPlanNode>, DataFusionError>

Serialize this plan to its protobuf representation, if it knows how.