Enum polars_lazy::logical_plan::LogicalPlan

pub enum LogicalPlan {
    Selection {
        input: Box<LogicalPlan>,
        predicate: Expr,
    },
    Cache {
        input: Box<LogicalPlan>,
    },
    CsvScan {
        path: PathBuf,
        schema: SchemaRef,
        has_header: bool,
        delimiter: u8,
        ignore_errors: bool,
        skip_rows: usize,
        stop_after_n_rows: Option<usize>,
        with_columns: Option<Vec<String>>,
        predicate: Option<Expr>,
        aggregate: Vec<Expr>,
        cache: bool,
        low_memory: bool,
    },
    ParquetScan {
        path: PathBuf,
        schema: SchemaRef,
        with_columns: Option<Vec<String>>,
        predicate: Option<Expr>,
        aggregate: Vec<Expr>,
        stop_after_n_rows: Option<usize>,
        cache: bool,
    },
    DataFrameScan {
        df: Arc<DataFrame>,
        schema: SchemaRef,
        projection: Option<Vec<Expr>>,
        selection: Option<Expr>,
    },
    LocalProjection {
        expr: Vec<Expr>,
        input: Box<LogicalPlan>,
        schema: SchemaRef,
    },
    Projection {
        expr: Vec<Expr>,
        input: Box<LogicalPlan>,
        schema: SchemaRef,
    },
    Aggregate {
        input: Box<LogicalPlan>,
        keys: Arc<Vec<Expr>>,
        aggs: Vec<Expr>,
        schema: SchemaRef,
        apply: Option<Arc<dyn DataFrameUdf>>,
    },
    Join {
        input_left: Box<LogicalPlan>,
        input_right: Box<LogicalPlan>,
        schema: SchemaRef,
        how: JoinType,
        left_on: Vec<Expr>,
        right_on: Vec<Expr>,
        allow_par: bool,
        force_par: bool,
    },
    HStack {
        input: Box<LogicalPlan>,
        exprs: Vec<Expr>,
        schema: SchemaRef,
    },
    Distinct {
        input: Box<LogicalPlan>,
        maintain_order: bool,
        subset: Arc<Option<Vec<String>>>,
    },
    Sort {
        input: Box<LogicalPlan>,
        by_column: Vec<Expr>,
        reverse: Vec<bool>,
    },
    Explode {
        input: Box<LogicalPlan>,
        columns: Vec<String>,
    },
    Slice {
        input: Box<LogicalPlan>,
        offset: i64,
        len: usize,
    },
    Melt {
        input: Box<LogicalPlan>,
        id_vars: Arc<Vec<String>>,
        value_vars: Arc<Vec<String>>,
        schema: SchemaRef,
    },
    Udf {
        input: Box<LogicalPlan>,
        function: Arc<dyn DataFrameUdf>,
        predicate_pd: bool,
        projection_pd: bool,
        schema: Option<SchemaRef>,
    },
}

Variants

Selection

Filter on a boolean mask

Fields of Selection

input: Box<LogicalPlan>predicate: Expr

Cache

Cache the input at this point in the LP

Fields of Cache

input: Box<LogicalPlan>

CsvScan

Scan a CSV file

Fields of CsvScan

path: PathBufschema: SchemaRefhas_header: booldelimiter: u8ignore_errors: boolskip_rows: usizestop_after_n_rows: Option<usize>with_columns: Option<Vec<String>>predicate: Option<Expr>

Filters at the scan level

aggregate: Vec<Expr>

Aggregations at the scan level

cache: boollow_memory: bool

ParquetScan

This is supported on crate feature parquet only.

Scan a Parquet file

Fields of ParquetScan

path: PathBufschema: SchemaRefwith_columns: Option<Vec<String>>predicate: Option<Expr>aggregate: Vec<Expr>stop_after_n_rows: Option<usize>cache: bool

DataFrameScan

In memory DataFrame

Fields of DataFrameScan

df: Arc<DataFrame>schema: SchemaRefprojection: Option<Vec<Expr>>selection: Option<Expr>

LocalProjection

Fields of LocalProjection

expr: Vec<Expr>input: Box<LogicalPlan>schema: SchemaRef

Projection

Column selection

Fields of Projection

expr: Vec<Expr>input: Box<LogicalPlan>schema: SchemaRef

Aggregate

Groupby aggregation

Fields of Aggregate

input: Box<LogicalPlan>keys: Arc<Vec<Expr>>aggs: Vec<Expr>schema: SchemaRefapply: Option<Arc<dyn DataFrameUdf>>

Join

Join operation

Fields of Join

input_left: Box<LogicalPlan>input_right: Box<LogicalPlan>schema: SchemaRefhow: JoinTypeleft_on: Vec<Expr>right_on: Vec<Expr>allow_par: boolforce_par: bool

HStack

Adding columns to the table without a Join

Fields of HStack

input: Box<LogicalPlan>exprs: Vec<Expr>schema: SchemaRef

Distinct

Remove duplicates from the table

Fields of Distinct

input: Box<LogicalPlan>maintain_order: boolsubset: Arc<Option<Vec<String>>>

Sort

Sort the table

Fields of Sort

input: Box<LogicalPlan>by_column: Vec<Expr>reverse: Vec<bool>

Explode

An explode operation

Fields of Explode

input: Box<LogicalPlan>columns: Vec<String>

Slice

Slice the table

Fields of Slice

input: Box<LogicalPlan>offset: i64len: usize

Melt

A Melt operation

Fields of Melt

input: Box<LogicalPlan>id_vars: Arc<Vec<String>>value_vars: Arc<Vec<String>>schema: SchemaRef

Udf

A User Defined Function

Fields of Udf

input: Box<LogicalPlan>function: Arc<dyn DataFrameUdf>predicate_pd: bool

allow predicate pushdown optimizations

projection_pd: bool

allow projection pushdown optimizations

schema: Option<SchemaRef>

Implementations

impl LogicalPlan

pub fn describe(&self) -> String

Trait Implementations

impl Clone for LogicalPlan

fn clone(&self) -> LogicalPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LogicalPlan

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

Formats the value using the given formatter.

impl Default for LogicalPlan

fn default() -> Self

Returns the “default value” for a type.

impl From<LogicalPlan> for LazyFrame

fn from(plan: LogicalPlan) -> Self

Performs the conversion.

impl From<LogicalPlan> for LogicalPlanBuilder

fn from(lp: LogicalPlan) -> Self

Performs the conversion.