Struct DataSourceExec

pub struct DataSourceExec { /* private fields */ }

ExecutionPlan that reads one or more files

DataSourceExec implements common functionality such as applying projections, and caching plan properties.

The DataSource describes where to find the data for this data source (for example in files or what in memory partitions).

For file based DataSources, format specific behavior is implemented in the FileSource trait.

Implementations

impl DataSourceExec

pub fn from_data_source(data_source: impl DataSource + 'static) -> Arc<Self>

pub fn new(data_source: Arc<dyn DataSource>) -> Self

pub fn data_source(&self) -> &Arc<dyn DataSource>

Return the source object

pub fn with_data_source(self, data_source: Arc<dyn DataSource>) -> Self

pub fn with_constraints(self, constraints: Constraints) -> Self

Assign constraints

pub fn with_partitioning(self, partitioning: Partitioning) -> Self

Assign output partitioning

pub fn downcast_to_file_source<T: 'static>( &self, ) -> Option<(&FileScanConfig, &T)>

Downcast the DataSourceExec’s data_source to a specific file source

Returns None if

1. the datasource is not scanning files (FileScanConfig)
2. The FileScanConfig::file_source is not of type T

Trait Implementations

impl Clone for DataSourceExec

fn clone(&self) -> DataSourceExec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataSourceExec

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

Formats the value using the given formatter.

impl DisplayAs for DataSourceExec

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 DataSourceExec

fn repartitioned( &self, target_partitions: usize, config: &ConfigOptions, ) -> Result<Option<Arc<dyn ExecutionPlan>>>

Implementation of ExecutionPlan::repartitioned which relies upon the inner DataSource::repartitioned.

If the data source does not support changing its partitioning, returns Ok(None) (the default). Refer to ExecutionPlan::repartitioned for more details.

fn name(&self) -> &'static str

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

fn as_any(&self) -> &dyn Any

Returns the execution plan as Any so that it can be downcast to a specific implementation.

fn properties(&self) -> &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 with_new_children( self: Arc<Self>, _: Vec<Arc<dyn ExecutionPlan>>, ) -> Result<Arc<dyn ExecutionPlan>>

Returns a new ExecutionPlan where all existing children were replaced by the children, in order

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

Begin execution of partition, returning a Stream of RecordBatches.

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

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

fn statistics(&self) -> Result<Statistics>

👎Deprecated since 48.0.0: Use partition_statistics method instead

Returns statistics for this ExecutionPlan node. If statistics are not available, should return Statistics::new_unknown (the default), not an error.

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

Returns statistics for a specific partition of this ExecutionPlan node. If statistics are not available, should return Statistics::new_unknown (the default), not an error. If partition is None, it returns statistics for the entire plan.

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 try_swapping_with_projection( &self, projection: &ProjectionExec, ) -> Result<Option<Arc<dyn ExecutionPlan>>>

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

fn handle_child_pushdown_result( &self, child_pushdown_result: ChildPushdownResult, config: &ConfigOptions, ) -> Result<FilterPushdownPropagation<Arc<dyn ExecutionPlan>>>

Handle the result of a child pushdown. This is called as we recurse back up the plan tree after recursing down and calling ExecutionPlan::gather_filters_for_pushdown. Once we know what the result of pushing down filters into children is we ask the current node what it wants to do with that result. For a DataSourceExec that may be absorbing the filters to apply them during the scan phase (also known as late materialization). A FilterExec may absorb any filters its children could not absorb, or if there are no filters left it may remove itself from the plan altogether. It combines both ChildPushdownResult::parent_filters and ChildPushdownResult::self_filters into a single predicate and replaces it’s own predicate. Then it passes PredicateSupport::Supported for each parent predicate to the parent. A HashJoinExec may ignore the pushdown result since it needs to apply the filters as part of the join anyhow. It passes ChildPushdownResult::parent_filters back up to it’s parents wrapped in FilterPushdownPropagation::transparent and ChildPushdownResult::self_filters is discarded.

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 schema(&self) -> Arc<Schema>

Get the schema for this execution plan

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 required_input_distribution(&self) -> Vec<Distribution>

Specifies the data distribution requirements for all the children for this ExecutionPlan, By default it’s [Distribution::UnspecifiedDistribution] for each child,

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

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 supports_limit_pushdown(&self) -> bool

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

fn cardinality_effect(&self) -> CardinalityEffect

Gets the effect on cardinality, if known

fn gather_filters_for_pushdown( &self, 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:

impl<S> From<S> for DataSourceExec

where S: DataSource + 'static,

Create a new DataSourceExec from a DataSource

fn from(source: S) -> Self

Converts to this type from the input type.