Struct datafusion::physical_plan::csv::CsvExec

pub struct CsvExec { /* fields omitted */ }

Execution plan for scanning a CSV file

Implementations

impl CsvExec

pub fn try_new(
    path: &str,
    options: CsvReadOptions<'_>,
    projection: Option<Vec<usize>>,
    batch_size: usize,
    limit: Option<usize>
) -> Result<Self>

Create a new execution plan for reading a set of CSV files

pub fn try_new_from_reader(
    reader: impl Read + Send + Sync + 'static,
    options: CsvReadOptions<'_>,
    projection: Option<Vec<usize>>,
    batch_size: usize,
    limit: Option<usize>
) -> Result<Self>

Create a new execution plan for reading from a reader

pub fn path(&self) -> &str

Path to directory containing partitioned CSV files with the same schema

pub fn filenames(&self) -> &[String]

The individual files under path

pub fn has_header(&self) -> bool

Does the CSV file have a header?

pub fn delimiter(&self) -> Option<&u8>

An optional column delimiter. Defaults to b','

pub fn file_extension(&self) -> &str

File extension

pub fn file_schema(&self) -> SchemaRef

Get the schema of the CSV file

pub fn projection(&self) -> Option<&Vec<usize>>

Optional projection for which columns to load

pub fn batch_size(&self) -> usize

Batch size

pub fn limit(&self) -> Option<usize>

Limit

pub fn try_infer_schema(
    filenames: &[String],
    options: &CsvReadOptions<'_>
) -> Result<Schema>

Infer schema for given CSV dataset

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 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,
    children: Vec<Arc<dyn ExecutionPlan>>
) -> Result<Arc<dyn ExecutionPlan>>

Returns a new plan where all children were replaced by new plans. The size of children must be equal to the size of ExecutionPlan::children().

fn execute<'life0, 'async_trait>(
    &'life0 self,
    partition: usize
) -> Pin<Box<dyn Future<Output = Result<SendableRecordBatchStream>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

creates an iterator

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

Format this ExecutionPlan to f in the specified type.

fn required_child_distribution(&self) -> Distribution

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

fn metrics(&self) -> HashMap<String, SQLMetric>

Return a snapshot of the metrics collected during execution