Enum polars_plan::plans::FunctionNode

pub enum FunctionNode {
    OpaquePython {
        function: PythonFunction,
        schema: Option<SchemaRef>,
        predicate_pd: bool,
        projection_pd: bool,
        streamable: bool,
        validate_output: bool,
    },
    Opaque {
        function: Arc<dyn DataFrameUdf>,
        schema: Option<Arc<dyn UdfSchema>>,
        predicate_pd: bool,
        projection_pd: bool,
        streamable: bool,
        fmt_str: &'static str,
    },
    Count {
        paths: Arc<[PathBuf]>,
        scan_type: FileScan,
        alias: Option<Arc<str>>,
    },
    Pipeline {
        function: Arc<Mutex<dyn DataFrameUdfMut>>,
        schema: SchemaRef,
        original: Option<Arc<IRPlan>>,
    },
    Unnest {
        columns: Arc<[Arc<str>]>,
    },
    Rechunk,
    MergeSorted {
        column: Arc<str>,
    },
    Rename {
        existing: Arc<[String]>,
        new: Arc<[String]>,
        swapping: bool,
        schema: CachedSchema,
    },
    Explode {
        columns: Arc<[Arc<str>]>,
        schema: CachedSchema,
    },
    Unpivot {
        args: Arc<UnpivotArgs>,
        schema: CachedSchema,
    },
    RowIndex {
        name: Arc<str>,
        schema: CachedSchema,
        offset: Option<IdxSize>,
    },
}

Variants

OpaquePython

Available on crate feature python only.

Fields

function: PythonFunction

schema: Option<SchemaRef>

predicate_pd: bool

allow predicate pushdown optimizations

projection_pd: bool

allow projection pushdown optimizations

streamable: bool

validate_output: bool

Opaque

Fields

function: Arc<dyn DataFrameUdf>

schema: Option<Arc<dyn UdfSchema>>

predicate_pd: bool

allow predicate pushdown optimizations

projection_pd: bool

allow projection pushdown optimizations

streamable: bool

fmt_str: &'static str

Count

Fields

paths: Arc<[PathBuf]>

scan_type: FileScan

alias: Option<Arc<str>>

Pipeline

Streaming engine pipeline

Fields

function: Arc<Mutex<dyn DataFrameUdfMut>>

schema: SchemaRef

original: Option<Arc<IRPlan>>

Unnest

Fields

columns: Arc<[Arc<str>]>

Rechunk

MergeSorted

Available on crate feature merge_sorted only.

Fields

column: Arc<str>

Rename

Fields

existing: Arc<[String]>

new: Arc<[String]>

swapping: bool

schema: CachedSchema

Explode

Fields

columns: Arc<[Arc<str>]>

schema: CachedSchema

Unpivot

Fields

args: Arc<UnpivotArgs>

schema: CachedSchema

RowIndex

Fields

name: Arc<str>

schema: CachedSchema

offset: Option<IdxSize>

Implementations

impl FunctionNode

pub fn is_streamable(&self) -> bool

Whether this function can run on batches of data at a time.

pub fn expands_rows(&self) -> bool

Whether this function will increase the number of rows

pub fn evaluate(&self, df: DataFrame) -> PolarsResult<DataFrame>

pub fn to_streaming_lp(&self) -> Option<IRPlanRef<'_>>

Trait Implementations

impl Clone for FunctionNode

fn clone(&self) -> FunctionNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionNode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FunctionNode

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

Formats the value using the given formatter.

impl From<FunctionNode> for DslFunction

fn from(value: FunctionNode) -> Self

Converts to this type from the input type.

impl Hash for FunctionNode

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FunctionNode

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FunctionNode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FunctionNode