Struct datafusion::physical_plan::file_format::CsvExec

pub struct CsvExec { /* private fields */ }

Execution plan for scanning a CSV file

Implementations

impl CsvExec

pub fn new(base_config: FileScanConfig, has_header: bool, delimiter: u8) -> Self

Create a new CSV reader execution plan provided base and specific configurations

pub fn base_config(&self) -> &FileScanConfig

Ref to the base configs

pub fn has_header(&self) -> bool

true if the first line of each file is a header

pub fn delimiter(&self) -> u8

A column delimiter

Trait Implementations

impl Clone for CsvExec

fn clone(&self) -> CsvExec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsvExec

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

Formats the value using the given formatter.

impl ExecutionPlan for CsvExec

fn as_any(&self) -> &dyn Any

Return a reference to Any that can be used for downcasting

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

fn output_partitioning(&self) -> Partitioning

Get the output partitioning of this plan

fn relies_on_input_order(&self) -> bool

Returns true if this operator relies on its inputs being produced in a certain order (for example that they are sorted a particular way) for correctness.

fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>

If the output of this operator is sorted, returns Some(keys) with the description of how it was sorted.

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

Get a list of child execution plans that provide the input for this plan. The returned list will be empty for leaf nodes, 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 plan where all children were replaced by new plans.

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

creates an iterator

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

Format this ExecutionPlan to f in the specified type.

fn statistics(&self) -> Statistics

Returns the global output statistics for this ExecutionPlan node.

fn required_child_distribution(&self) -> Distribution

Specifies the data distribution requirements of all the children for this operator

fn maintains_input_order(&self) -> bool

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

fn benefits_from_input_partitioning(&self) -> bool

Returns true if this operator would benefit from partitioning its input (and thus from more parallelism). For operators that do very little work the overhead of extra parallelism may outweigh any benefits

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

Return a snapshot of the set of Metrics for this ExecutionPlan.