Enum polars::prelude::LogicalPlan

source · [−]

pub enum LogicalPlan {
Show 20 variants    AnonymousScan {
        function: Arc<dyn AnonymousScan + 'static>,
        schema: Arc<Schema>,
        predicate: Option<Expr>,
        aggregate: Vec<Expr, Global>,
        options: AnonymousScanOptions,
    },
    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: IpcScanOptionsInner,
        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>,
        schema: Arc<Schema>,
    },
    Slice {
        input: Box<LogicalPlan, Global>,
        offset: i64,
        len: u32,
    },
    Melt {
        input: Box<LogicalPlan, Global>,
        args: Arc<MeltArgs>,
        schema: Arc<Schema>,
    },
    Udf {
        input: Box<LogicalPlan, Global>,
        function: Arc<dyn DataFrameUdf + 'static>,
        options: LogicalPlanUdfOptions,
        schema: Option<Arc<dyn UdfSchema + 'static>>,
    },
    Union {
        inputs: Vec<LogicalPlan, Global>,
        options: UnionOptions,
    },
    Error {
        input: Box<LogicalPlan, Global>,
        err: Arc<Mutex<RawMutex, Option<PolarsError>>>,
    },
}

Variants

`AnonymousScan`

Fields

function: Arc<dyn AnonymousScan + 'static>

schema: Arc<Schema>

predicate: Option<Expr>

aggregate: Vec<Expr, Global>

options: AnonymousScanOptions

`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

Scan a Parquet file

`IpcScan`

Fields

path: PathBuf

schema: Arc<Schema>

options: IpcScanOptionsInner

predicate: Option<Expr>

aggregate: Vec<Expr, Global>

`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>

schema: Arc<Schema>

An explode operation

`Slice`

Fields

input: Box<LogicalPlan, Global>

offset: i64

len: u32

Slice the table

`Melt`

Fields

input: Box<LogicalPlan, Global>

args: Arc<MeltArgs>

schema: Arc<Schema>

A Melt operation

`Udf`

Fields

input: Box<LogicalPlan, Global>

function: Arc<dyn DataFrameUdf + 'static>

options: LogicalPlanUdfOptions

schema: Option<Arc<dyn UdfSchema + 'static>>

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

source

impl LogicalPlan

source

pub fn describe(&self) -> String

Trait Implementations

source

impl Clone for LogicalPlan

source

fn clone(&self) -> LogicalPlan

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for LogicalPlan

source

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

Formats the value using the given formatter. Read more

source

impl Default for LogicalPlan

source

fn default() -> LogicalPlan

Returns the “default value” for a type. Read more

source

impl From<LogicalPlan> for LazyFrame

source

fn from(plan: LogicalPlan) -> LazyFrame

Converts to this type from the input type.

Auto Trait Implementations

impl !RefUnwindSafe for LogicalPlan

impl Send for LogicalPlan

impl Sync for LogicalPlan

impl Unpin for LogicalPlan

impl !UnwindSafe for LogicalPlan

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum polars::prelude::LogicalPlan

Variants

AnonymousScan

Fields

Selection

Fields

Cache

Fields

CsvScan

Fields

ParquetScan

Fields

IpcScan

Fields

DataFrameScan

Fields

LocalProjection

Fields

Projection

Fields

Aggregate

Fields

Join

Fields

HStack

Fields

Distinct

Fields

Sort

Fields

Explode

Fields

Slice

Fields

Melt

Fields

Udf

Fields

Union

Fields

Error

Fields

Implementations

impl LogicalPlan

pub fn describe(&self) -> String

Trait Implementations

impl Clone for LogicalPlan

fn clone(&self) -> LogicalPlan

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

impl Debug for LogicalPlan

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

impl Default for LogicalPlan

fn default() -> LogicalPlan

impl From<LogicalPlan> for LazyFrame

fn from(plan: LogicalPlan) -> LazyFrame

Auto Trait Implementations

impl !RefUnwindSafe for LogicalPlan

impl Send for LogicalPlan

impl Sync for LogicalPlan

impl Unpin for LogicalPlan

impl !UnwindSafe for LogicalPlan

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> DynClone for T where T: Clone,

fn __clone_box(&self, Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

`AnonymousScan`

`Selection`

`Cache`

`CsvScan`

`ParquetScan`

`IpcScan`

`DataFrameScan`

`LocalProjection`

`Projection`

`Aggregate`

`Join`

`HStack`

`Distinct`

`Sort`

`Explode`

`Slice`

`Melt`

`Udf`

`Union`

`Error`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> DynClone for T where
T: Clone,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,