Expand description
Domain specific language for the Lazy API.
Re-exports§
pub use udf::UserDefinedFunction;pub use crate::plans::lit;pub use cat::*;dtype-categoricalpub use function_expr::*;pub use functions::*;
Modules§
- binary
- cat
dtype-categorical - deletion
- dt
temporal - function_
expr - functions
- Functions
- named_
serde serde - python_
dataset python - python_
dsl python - string
strings - udf
Structs§
- Anonymous
Scan Options - Array
Name Space dtype-array - Specialized expressions for
SeriesofDataType::Array. - Cast
Columns Policy - Used by scans.
- Chained
Then - Utility struct for the
when-then-otherwiseexpression. - Chained
When - Utility struct for the
when-then-otherwiseexpression. - Distinct
OptionsDSL - DslBuilder
- Expr
Name Name Space - Specialized expressions for modifying the name of existing expressions.
- File
Sink Options - File
Sink Type - Groupby
Options - HConcat
Options - Join
Options - Join
OptionsIR - List
Name Space - Specialized expressions for
SeriesofDataType::List. - Logical
Plan UdfOptions - Match
ToSchema PerColumn - Meta
Name Space meta - Specialized expressions for Categorical dtypes.
- NDJson
Read Options json - Partition
Sink Type - Partition
Sink TypeIR - Partition
Target Context - Partition
Target Context Key - Python
Dataset ProviderV Table python - Rolling
CovOptions - Scan
Flags - Scan
Source Iter - An iterator for
ScanSources - Sink
Finish Context - Sink
Options - Options that apply to all sinks.
- Sink
Written - Sort
Column - Sort
ColumnIR - Special
Eq - Wrapper type that has special equality properties depending on the inner type specialization
- Strptime
Options - Struct
Name Space dtype-struct - Specialized expressions for Struct dtypes.
- Then
- Utility struct for the
when-then-otherwiseexpression. - Unified
Scan Args - Scan arguments shared across different scan types.
- Union
Args - Union
Options - Unpivot
ArgsDSL - When
- Utility struct for the
when-then-otherwiseexpression.
Enums§
- AggExpr
- Data
Type Expr - DslPlan
- Engine
- Eval
Variant - Excluded
- Expr
- Expressions that can be used in various contexts.
- Extra
Columns Policy - File
Scan - File
Type - Join
Type OptionsIR - Lazy
Serde - Missing
Columns Policy - Missing
Columns Policy OrExpr - Nested
Type - Operator
- Partition
Target Callback - Partition
Variant - Partition
VariantIR - Rename
Alias Fn - Scan
Source - A single source to scan from
- Scan
Source Ref - A reference to a single item in
ScanSources - Scan
Sources - Set of sources to scan from
- Selector
- Sink
Finish Callback - Sink
Target - Sink
Type - Sink
TypeIR - Upcast
OrForbid - Window
Mapping - Window
Type
Statics§
- DATASET_
PROVIDER_ VTABLE python - This is for
polars-pythonto inject so that the implementation can be done there: - DSL_
VERSION
Traits§
- Binary
UdfOutput Field - Column
Binary Udf - A wrapper trait for any binary closure
Fn(Column, Column) -> PolarsResult<Column> - Columns
Udf - A wrapper trait for any closure
Fn(Vec<Series>) -> PolarsResult<Series> - Function
Output Field
Functions§
- apply_
multiple - Apply a function/closure over the groups of multiple columns. This should only be used in a group_by aggregation.
- binary_
expr - Compute
op(l, r)(or equivalentlyl op r).landrmust have types compatible with the Operator. - first
- First column in a DataFrame.
- last
- Last column in a DataFrame.
- len
- Return the number of rows in the context.
- map_
multiple - Apply a function/closure over multiple columns once the logical plan get executed.
- nth
- Nth column in a DataFrame.
- ternary_
expr - when
- Start a
when-then-otherwiseexpression.