Enum polars::prelude::LogicalPlan

pub enum LogicalPlan {
    Selection {
        input: Box<LogicalPlan, Global>,
        predicate: Expr,
    },
    Cache {
        input: Box<LogicalPlan, Global>,
    },
    CsvScan {
        path: PathBuf,
        schema: Arc<Schema>,
        options: CsvParserOptions,
        predicate: Option<Expr>,
        aggregate: Vec<Expr, Global>,
    },
    ParquetScan {
        path: PathBuf,
        schema: Arc<Schema>,
        predicate: Option<Expr>,
        aggregate: Vec<Expr, Global>,
        options: ParquetOptions,
    },
    IpcScan {
        path: PathBuf,
        schema: Arc<Schema>,
        options: IpcScanOptions,
        predicate: Option<Expr>,
        aggregate: Vec<Expr, Global>,
    },
    DataFrameScan {
        df: Arc<DataFrame>,
        schema: Arc<Schema>,
        projection: Option<Vec<Expr, Global>>,
        selection: Option<Expr>,
    },
    LocalProjection {
        expr: Vec<Expr, Global>,
        input: Box<LogicalPlan, Global>,
        schema: Arc<Schema>,
    },
    Projection {
        expr: Vec<Expr, Global>,
        input: Box<LogicalPlan, Global>,
        schema: Arc<Schema>,
    },
    Aggregate {
        input: Box<LogicalPlan, Global>,
        keys: Arc<Vec<Expr, Global>>,
        aggs: Vec<Expr, Global>,
        schema: Arc<Schema>,
        apply: Option<Arc<dyn DataFrameUdf + 'static>>,
        maintain_order: bool,
        options: GroupbyOptions,
    },
    Join {
        input_left: Box<LogicalPlan, Global>,
        input_right: Box<LogicalPlan, Global>,
        schema: Arc<Schema>,
        left_on: Vec<Expr, Global>,
        right_on: Vec<Expr, Global>,
        options: JoinOptions,
    },
    HStack {
        input: Box<LogicalPlan, Global>,
        exprs: Vec<Expr, Global>,
        schema: Arc<Schema>,
    },
    Distinct {
        input: Box<LogicalPlan, Global>,
        options: DistinctOptions,
    },
    Sort {
        input: Box<LogicalPlan, Global>,
        by_column: Vec<Expr, Global>,
        args: SortArguments,
    },
    Explode {
        input: Box<LogicalPlan, Global>,
        columns: Vec<String, Global>,
    },
    Slice {
        input: Box<LogicalPlan, Global>,
        offset: i64,
        len: u32,
    },
    Melt {
        input: Box<LogicalPlan, Global>,
        id_vars: Arc<Vec<String, Global>>,
        value_vars: Arc<Vec<String, Global>>,
        schema: Arc<Schema>,
    },
    Udf {
        input: Box<LogicalPlan, Global>,
        function: Arc<dyn DataFrameUdf + 'static>,
        options: LogicalPlanUdfOptions,
        schema: Option<Arc<Schema>>,
    },
    Union {
        inputs: Vec<LogicalPlan, Global>,
        options: UnionOptions,
    },
    Error {
        input: Box<LogicalPlan, Global>,
        err: Arc<Mutex<RawMutex, Option<PolarsError>>>,
    },
}

Variants

Selection

Fields

input: Box<LogicalPlan, Global>

predicate: Expr

Filter on a boolean mask

Cache

Fields

input: Box<LogicalPlan, Global>

Cache the input at this point in the LP

CsvScan

Fields

path: PathBuf

schema: Arc<Schema>

options: CsvParserOptions

predicate: Option<Expr>

Filters at the scan level

aggregate: Vec<Expr, Global>

Aggregations at the scan level

Scan a CSV file

ParquetScan

Fields

path: PathBuf

schema: Arc<Schema>

predicate: Option<Expr>

aggregate: Vec<Expr, Global>

options: ParquetOptions

This is supported on crate feature parquet only.

Scan a Parquet file

IpcScan

Fields

path: PathBuf

schema: Arc<Schema>

options: IpcScanOptions

predicate: Option<Expr>

aggregate: Vec<Expr, Global>

This is supported on crate feature ipc only.

DataFrameScan

Fields

df: Arc<DataFrame>

schema: Arc<Schema>

projection: Option<Vec<Expr, Global>>

selection: Option<Expr>

In memory DataFrame

LocalProjection

Fields

expr: Vec<Expr, Global>

input: Box<LogicalPlan, Global>

schema: Arc<Schema>

Projection

Fields

expr: Vec<Expr, Global>

input: Box<LogicalPlan, Global>

schema: Arc<Schema>

Column selection

Aggregate

Fields

input: Box<LogicalPlan, Global>

keys: Arc<Vec<Expr, Global>>

aggs: Vec<Expr, Global>

schema: Arc<Schema>

apply: Option<Arc<dyn DataFrameUdf + 'static>>

maintain_order: bool

options: GroupbyOptions

Groupby aggregation

Join

Fields

input_left: Box<LogicalPlan, Global>

input_right: Box<LogicalPlan, Global>

schema: Arc<Schema>

left_on: Vec<Expr, Global>

right_on: Vec<Expr, Global>

options: JoinOptions

Join operation

HStack

Fields

input: Box<LogicalPlan, Global>

exprs: Vec<Expr, Global>

schema: Arc<Schema>

Adding columns to the table without a Join

Distinct

Fields

input: Box<LogicalPlan, Global>

options: DistinctOptions

Remove duplicates from the table

Sort

Fields

input: Box<LogicalPlan, Global>

by_column: Vec<Expr, Global>

args: SortArguments

Sort the table

Explode

Fields

input: Box<LogicalPlan, Global>

columns: Vec<String, Global>

An explode operation

Slice

Fields

input: Box<LogicalPlan, Global>

offset: i64

len: u32

Slice the table

Melt

Fields

input: Box<LogicalPlan, Global>

id_vars: Arc<Vec<String, Global>>

value_vars: Arc<Vec<String, Global>>

schema: Arc<Schema>

A Melt operation

Udf

Fields

input: Box<LogicalPlan, Global>

function: Arc<dyn DataFrameUdf + 'static>

options: LogicalPlanUdfOptions

schema: Option<Arc<Schema>>

A User Defined Function

Union

Fields

inputs: Vec<LogicalPlan, Global>

options: UnionOptions

Error

Fields

input: Box<LogicalPlan, Global>

err: Arc<Mutex<RawMutex, Option<PolarsError>>>

Catches errors and throws them later

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<(), Error>

Formats the value using the given formatter.

impl Default for LogicalPlan

fn default() -> LogicalPlan

Returns the “default value” for a type.

impl From<LogicalPlan> for LazyFrame

fn from(plan: LogicalPlan) -> LazyFrame

Performs the conversion.