Struct datafusion::logical_expr::SimpleWindowUDF
source · pub struct SimpleWindowUDF { /* private fields */ }
Expand description
Implements WindowUDFImpl
for functions that have a single signature and
return type.
Implementations§
source§impl SimpleWindowUDF
impl SimpleWindowUDF
sourcepub fn new(
name: impl Into<String>,
input_type: DataType,
return_type: DataType,
volatility: Volatility,
partition_evaluator_factory: Arc<dyn Fn() -> Result<Box<dyn PartitionEvaluator>, DataFusionError> + Sync + Send>,
) -> SimpleWindowUDF
pub fn new( name: impl Into<String>, input_type: DataType, return_type: DataType, volatility: Volatility, partition_evaluator_factory: Arc<dyn Fn() -> Result<Box<dyn PartitionEvaluator>, DataFusionError> + Sync + Send>, ) -> SimpleWindowUDF
Create a new SimpleWindowUDF
from a name, input types, return type and
implementation. Implementing WindowUDFImpl
allows more flexibility
Trait Implementations§
source§impl Debug for SimpleWindowUDF
impl Debug for SimpleWindowUDF
source§impl WindowUDFImpl for SimpleWindowUDF
impl WindowUDFImpl for SimpleWindowUDF
source§fn signature(&self) -> &Signature
fn signature(&self) -> &Signature
Returns the function’s
Signature
for information about what input
types are accepted and the function’s Volatility.source§fn return_type(
&self,
_arg_types: &[DataType],
) -> Result<DataType, DataFusionError>
fn return_type( &self, _arg_types: &[DataType], ) -> Result<DataType, DataFusionError>
What
DataType
will be returned by this function, given the types of
the argumentssource§fn partition_evaluator(
&self,
) -> Result<Box<dyn PartitionEvaluator>, DataFusionError>
fn partition_evaluator( &self, ) -> Result<Box<dyn PartitionEvaluator>, DataFusionError>
Invoke the function, returning the
PartitionEvaluator
instancesource§fn aliases(&self) -> &[String]
fn aliases(&self) -> &[String]
Returns any aliases (alternate names) for this function. Read more
source§fn simplify(
&self,
) -> Option<Box<dyn Fn(WindowFunction, &dyn SimplifyInfo) -> Result<Expr, DataFusionError>>>
fn simplify( &self, ) -> Option<Box<dyn Fn(WindowFunction, &dyn SimplifyInfo) -> Result<Expr, DataFusionError>>>
Optionally apply per-UDWF simplification / rewrite rules. Read more
source§fn equals(&self, other: &dyn WindowUDFImpl) -> bool
fn equals(&self, other: &dyn WindowUDFImpl) -> bool
Return true if this window UDF is equal to the other. Read more
source§fn hash_value(&self) -> u64
fn hash_value(&self) -> u64
Returns a hash value for this window UDF. Read more
source§fn nullable(&self) -> bool
fn nullable(&self) -> bool
Allows customizing nullable of column for this window UDF. Read more
source§fn sort_options(&self) -> Option<SortOptions>
fn sort_options(&self) -> Option<SortOptions>
Allows the window UDF to define a custom result ordering. Read more
source§fn coerce_types(
&self,
_arg_types: &[DataType],
) -> Result<Vec<DataType>, DataFusionError>
fn coerce_types( &self, _arg_types: &[DataType], ) -> Result<Vec<DataType>, DataFusionError>
Coerce arguments of a function call to types that the function can evaluate. Read more
Auto Trait Implementations§
impl Freeze for SimpleWindowUDF
impl !RefUnwindSafe for SimpleWindowUDF
impl Send for SimpleWindowUDF
impl Sync for SimpleWindowUDF
impl Unpin for SimpleWindowUDF
impl !UnwindSafe for SimpleWindowUDF
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
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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