polars::prelude

Enum DslPlan

pub enum DslPlan {
Show 17 variants Filter { input: Arc<DslPlan>, predicate: Expr, }, Cache { input: Arc<DslPlan>, id: usize, }, Scan { sources: ScanSources, file_info: Option<FileInfo>, file_options: FileScanOptions, scan_type: FileScan, cached_ir: Arc<Mutex<Option<IR>>>, }, DataFrameScan { df: Arc<DataFrame>, schema: Arc<Schema<DataType>>, }, Select { expr: Vec<Expr>, input: Arc<DslPlan>, options: ProjectionOptions, }, GroupBy { input: Arc<DslPlan>, keys: Vec<Expr>, aggs: Vec<Expr>, apply: Option<(Arc<dyn DataFrameUdf>, Arc<Schema<DataType>>)>, maintain_order: bool, options: Arc<GroupbyOptions>, }, Join { input_left: Arc<DslPlan>, input_right: Arc<DslPlan>, left_on: Vec<Expr>, right_on: Vec<Expr>, predicates: Vec<Expr>, options: Arc<JoinOptions>, }, HStack { input: Arc<DslPlan>, exprs: Vec<Expr>, options: ProjectionOptions, }, Distinct { input: Arc<DslPlan>, options: DistinctOptionsDSL, }, Sort { input: Arc<DslPlan>, by_column: Vec<Expr>, slice: Option<(i64, usize)>, sort_options: SortMultipleOptions, }, Slice { input: Arc<DslPlan>, offset: i64, len: u32, }, MapFunction { input: Arc<DslPlan>, function: DslFunction, }, Union { inputs: Vec<DslPlan>, args: UnionArgs, }, HConcat { inputs: Vec<DslPlan>, options: HConcatOptions, }, ExtContext { input: Arc<DslPlan>, contexts: Vec<DslPlan>, }, Sink { input: Arc<DslPlan>, payload: SinkType, }, IR { node: Option<Node>, version: u32, dsl: Arc<DslPlan>, },
}
Available on crate feature lazy only.

Variants§

§

Filter

Filter on a boolean mask

Fields

§input: Arc<DslPlan>
§predicate: Expr
§

Cache

Cache the input at this point in the LP

Fields

§input: Arc<DslPlan>
§

Scan

Fields

§sources: ScanSources
§file_info: Option<FileInfo>

Materialized at IR except for AnonymousScan.

§file_options: FileScanOptions
§scan_type: FileScan
§cached_ir: Arc<Mutex<Option<IR>>>

Local use cases often repeatedly collect the same LazyFrame (e.g. in interactive notebook use-cases), so we cache the IR conversion here, as the path expansion can be quite slow (especially for cloud paths).

§

DataFrameScan

In memory DataFrame

Fields

§schema: Arc<Schema<DataType>>
§

Select

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

Fields

§expr: Vec<Expr>
§input: Arc<DslPlan>
§options: ProjectionOptions
§

GroupBy

Groupby aggregation

Fields

§input: Arc<DslPlan>
§keys: Vec<Expr>
§aggs: Vec<Expr>
§apply: Option<(Arc<dyn DataFrameUdf>, Arc<Schema<DataType>>)>
§maintain_order: bool
§options: Arc<GroupbyOptions>
§

Join

Join operation

Fields

§input_left: Arc<DslPlan>
§input_right: Arc<DslPlan>
§left_on: Vec<Expr>
§right_on: Vec<Expr>
§predicates: Vec<Expr>
§options: Arc<JoinOptions>
§

HStack

Adding columns to the table without a Join

Fields

§input: Arc<DslPlan>
§exprs: Vec<Expr>
§options: ProjectionOptions
§

Distinct

Remove duplicates from the table

Fields

§input: Arc<DslPlan>
§options: DistinctOptionsDSL
§

Sort

Sort the table

Fields

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

Slice

Slice the table

Fields

§input: Arc<DslPlan>
§offset: i64
§len: u32
§

MapFunction

A (User Defined) Function

Fields

§input: Arc<DslPlan>
§function: DslFunction
§

Union

Vertical concatenation

Fields

§inputs: Vec<DslPlan>
§

HConcat

Horizontal concatenation of multiple plans

Fields

§inputs: Vec<DslPlan>
§options: HConcatOptions
§

ExtContext

This allows expressions to access other tables

Fields

§input: Arc<DslPlan>
§contexts: Vec<DslPlan>
§

Sink

Fields

§input: Arc<DslPlan>
§payload: SinkType
§

IR

Fields

§node: Option<Node>
§version: u32

Implementations§

§

impl DslPlan

pub fn compute_schema(&self) -> Result<Arc<Schema<DataType>>, PolarsError>

Compute the schema. This requires conversion to [IR] and type-resolving.

§

impl DslPlan

pub fn describe(&self) -> Result<String, PolarsError>

pub fn describe_tree_format(&self) -> Result<String, PolarsError>

pub fn display(&self) -> Result<impl Display, PolarsError>

pub fn to_alp(self) -> Result<IRPlan, PolarsError>

Trait Implementations§

§

impl Clone for DslPlan

§

fn clone(&self) -> DslPlan

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 Default for DslPlan

§

fn default() -> DslPlan

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

impl<'de> Deserialize<'de> for DslPlan

§

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

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

impl From<DslPlan> for DslBuilder

§

fn from(lp: DslPlan) -> DslBuilder

Converts to this type from the input type.
Source§

impl From<DslPlan> for LazyFrame

Source§

fn from(plan: DslPlan) -> LazyFrame

Converts to this type from the input type.
§

impl<'a> IntoIterator for &'a DslPlan

§

type Item = &'a DslPlan

The type of the elements being iterated over.
§

type IntoIter = DslPlanIter<'a>

Which kind of iterator are we turning this into?
§

fn into_iter(self) -> <&'a DslPlan as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
§

impl Serialize for DslPlan

§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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,

Source§

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

Source§

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

Source§

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

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

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

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T