Enum polars_lazy::prelude::LogicalPlan
source · pub enum LogicalPlan {
Show 16 variants
Selection {
input: Box<LogicalPlan>,
predicate: Expr,
},
Cache {
input: Box<LogicalPlan>,
id: usize,
count: usize,
},
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>,
},
Projection {
expr: Vec<Expr>,
input: Box<LogicalPlan>,
schema: Arc<Schema>,
options: ProjectionOptions,
},
Aggregate {
input: Box<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: Box<LogicalPlan>,
input_right: Box<LogicalPlan>,
schema: Arc<Schema>,
left_on: Vec<Expr>,
right_on: Vec<Expr>,
options: Arc<JoinOptions>,
},
HStack {
input: Box<LogicalPlan>,
exprs: Vec<Expr>,
schema: Arc<Schema>,
options: ProjectionOptions,
},
Distinct {
input: Box<LogicalPlan>,
options: DistinctOptions,
},
Sort {
input: Box<LogicalPlan>,
by_column: Vec<Expr>,
args: SortArguments,
},
Slice {
input: Box<LogicalPlan>,
offset: i64,
len: u64,
},
MapFunction {
input: Box<LogicalPlan>,
function: FunctionNode,
},
Union {
inputs: Vec<LogicalPlan>,
options: UnionOptions,
},
Error {
input: Box<LogicalPlan>,
err: ErrorStateSync,
},
ExtContext {
input: Box<LogicalPlan>,
contexts: Vec<LogicalPlan>,
schema: Arc<Schema>,
},
Sink {
input: Box<LogicalPlan>,
payload: SinkType,
},
}
Variants§
Selection
Filter on a boolean mask
Cache
Cache the input at this point in the LP
Scan
Fields
§
file_options: FileScanOptions
DataFrameScan
Fields
In memory DataFrame
Projection
Column selection
Aggregate
Groupby aggregation
Join
Join operation
HStack
Adding columns to the table without a Join
Distinct
Remove duplicates from the table
Sort
Sort the table
Slice
Slice the table
MapFunction
A (User Defined) Function
Union
Error
Catches errors and throws them later
ExtContext
This allows expressions to access other tables
Sink
Implementations§
source§impl LogicalPlan
impl LogicalPlan
sourcepub fn dot(
&self,
acc_str: &mut String,
id: (usize, usize),
prev_node: DotNode<'_>,
id_map: &mut HashMap<String, String, RandomState>
) -> Result<(), Error>
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.
Trait Implementations§
source§impl Clone for LogicalPlan
impl Clone for LogicalPlan
source§fn clone(&self) -> LogicalPlan
fn clone(&self) -> LogicalPlan
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for LogicalPlan
impl Debug for LogicalPlan
source§impl Default for LogicalPlan
impl Default for LogicalPlan
source§fn default() -> LogicalPlan
fn default() -> LogicalPlan
Returns the “default value” for a type. Read more
source§impl<'de> Deserialize<'de> for LogicalPlan
impl<'de> Deserialize<'de> for LogicalPlan
source§fn deserialize<__D>(
__deserializer: __D
) -> Result<LogicalPlan, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
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
impl From<LogicalPlan> for LazyFrame
source§fn from(plan: LogicalPlan) -> Self
fn from(plan: LogicalPlan) -> Self
Converts to this type from the input type.
source§impl Serialize for LogicalPlan
impl Serialize for LogicalPlan
source§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
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§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more