Enum polars_lazy::prelude::LogicalPlan

pub enum LogicalPlan {
Show 18 variants PythonScan { options: PythonOptions, }, Filter { input: Arc<LogicalPlan>, predicate: Expr, }, Cache { input: Arc<LogicalPlan>, id: usize, cache_hits: u32, }, Scan { paths: Arc<[PathBuf]>, file_info: FileInfo, predicate: Option<Expr>, file_options: FileScanOptions, scan_type: FileScan, }, DataFrameScan { df: Arc<DataFrame>, schema: Arc<Schema>, output_schema: Option<Arc<Schema>>, projection: Option<Arc<Vec<String>>>, selection: Option<Expr>, }, Select { expr: Vec<Expr>, input: Arc<LogicalPlan>, schema: Arc<Schema>, options: ProjectionOptions, }, GroupBy { input: Arc<LogicalPlan>, keys: Arc<Vec<Expr>>, aggs: Vec<Expr>, schema: Arc<Schema>, apply: Option<Arc<dyn DataFrameUdf>>, maintain_order: bool, options: Arc<GroupbyOptions>, }, Join { input_left: Arc<LogicalPlan>, input_right: Arc<LogicalPlan>, schema: Arc<Schema>, left_on: Vec<Expr>, right_on: Vec<Expr>, options: Arc<JoinOptions>, }, HStack { input: Arc<LogicalPlan>, exprs: Vec<Expr>, schema: Arc<Schema>, options: ProjectionOptions, }, Distinct { input: Arc<LogicalPlan>, options: DistinctOptions, }, Sort { input: Arc<LogicalPlan>, by_column: Vec<Expr>, slice: Option<(i64, usize)>, sort_options: SortMultipleOptions, }, Slice { input: Arc<LogicalPlan>, offset: i64, len: u64, }, MapFunction { input: Arc<LogicalPlan>, function: FunctionNode, }, Union { inputs: Vec<LogicalPlan>, options: UnionOptions, }, HConcat { inputs: Vec<LogicalPlan>, schema: Arc<Schema>, options: HConcatOptions, }, Error { input: Arc<LogicalPlan>, err: ErrorState, }, ExtContext { input: Arc<LogicalPlan>, contexts: Vec<LogicalPlan>, schema: Arc<Schema>, }, Sink { input: Arc<LogicalPlan>, payload: SinkType, },
}

Variants§

§

PythonScan

Available on crate feature python only.

Fields

§options: PythonOptions
§

Filter

Filter on a boolean mask

Fields

§predicate: Expr
§

Cache

Cache the input at this point in the LP

Fields

§cache_hits: u32
§

Scan

Fields

§paths: Arc<[PathBuf]>
§file_info: FileInfo
§predicate: Option<Expr>
§file_options: FileScanOptions
§scan_type: FileScan
§

DataFrameScan

In memory DataFrame

Fields

§schema: Arc<Schema>
§output_schema: Option<Arc<Schema>>
§projection: Option<Arc<Vec<String>>>
§selection: Option<Expr>
§

Select

Polars’ select operation, this can mean projection, but also full data access.

Fields

§expr: Vec<Expr>
§schema: Arc<Schema>
§options: ProjectionOptions
§

GroupBy

Groupby aggregation

Fields

§keys: Arc<Vec<Expr>>
§aggs: Vec<Expr>
§schema: Arc<Schema>
§apply: Option<Arc<dyn DataFrameUdf>>
§maintain_order: bool
§options: Arc<GroupbyOptions>
§

Join

Join operation

Fields

§input_left: Arc<LogicalPlan>
§input_right: Arc<LogicalPlan>
§schema: Arc<Schema>
§left_on: Vec<Expr>
§right_on: Vec<Expr>
§options: Arc<JoinOptions>
§

HStack

Adding columns to the table without a Join

Fields

§exprs: Vec<Expr>
§schema: Arc<Schema>
§options: ProjectionOptions
§

Distinct

Remove duplicates from the table

Fields

§options: DistinctOptions
§

Sort

Sort the table

Fields

§by_column: Vec<Expr>
§slice: Option<(i64, usize)>
§sort_options: SortMultipleOptions
§

Slice

Slice the table

Fields

§offset: i64
§len: u64
§

MapFunction

A (User Defined) Function

Fields

§function: FunctionNode
§

Union

Fields

§options: UnionOptions
§

HConcat

Horizontal concatenation of multiple plans

Fields

§schema: Arc<Schema>
§options: HConcatOptions
§

Error

Catches errors and throws them later

Fields

§err: ErrorState
§

ExtContext

This allows expressions to access other tables

Fields

§contexts: Vec<LogicalPlan>
§schema: Arc<Schema>
§

Sink

Fields

§payload: SinkType

Implementations§

§

impl LogicalPlan

pub fn dot( &self, acc_str: &mut String, id: (usize, usize), prev_node: DotNode<'_>, id_map: &mut HashMap<String, String, RandomState> ) -> Result<(), Error>

§Arguments

id - (branch, id) Used to make sure that the dot boxes are distinct. branch is an id per join/union branch id is incremented by the depth traversal of the tree.

§

impl LogicalPlan

pub fn schema(&self) -> Result<Cow<'_, Arc<Schema>>, PolarsError>

§

impl LogicalPlan

pub fn describe(&self) -> String

pub fn describe_tree_format(&self) -> String

pub fn to_alp(self) -> Result<(Node, Arena<IR>, Arena<AExpr>), PolarsError>

Trait Implementations§

§

impl Clone for LogicalPlan

§

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
§

impl Debug for LogicalPlan

§

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

Formats the value using the given formatter. Read more
§

impl Default for LogicalPlan

§

fn default() -> LogicalPlan

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

impl<'de> Deserialize<'de> for LogicalPlan

§

fn deserialize<__D>( __deserializer: __D ) -> Result<LogicalPlan, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl From<LogicalPlan> for LazyFrame

source§

fn from(plan: LogicalPlan) -> Self

Converts to this type from the input type.
§

impl Serialize for LogicalPlan

§

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

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

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

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 = _

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<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> Ungil for T
where T: Send,