Struct AliasedScalarUDFImpl 

struct AliasedScalarUDFImpl {
    inner: UdfEq<Arc<dyn ScalarUDFImpl>>,
    aliases: Vec<String>,
}

ScalarUDF that adds an alias to the underlying function. It is better to implement ScalarUDFImpl, which supports aliases, directly if possible.

Fields

inner: UdfEq<Arc<dyn ScalarUDFImpl>>

aliases: Vec<String>

Implementations

impl AliasedScalarUDFImpl

pub fn new( inner: Arc<dyn ScalarUDFImpl>, new_aliases: impl IntoIterator<Item = &'static str>, ) -> Self

Trait Implementations

impl Debug for AliasedScalarUDFImpl

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

Formats the value using the given formatter.

impl Hash for AliasedScalarUDFImpl

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 AliasedScalarUDFImpl

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl ScalarUDFImpl for AliasedScalarUDFImpl

fn as_any(&self) -> &dyn Any

Returns this object as an Any trait object

fn name(&self) -> &str

Returns this function’s name

fn display_name(&self, args: &[Expr]) -> Result<String>

👎Deprecated since 50.0.0: This method is unused and will be removed in a future release

Returns the user-defined display name of function, given the arguments

fn schema_name(&self, args: &[Expr]) -> Result<String>

Returns the name of the column this expression would create

fn signature(&self) -> &Signature

Returns a Signature describing the argument types for which this function has an implementation, and the function’s Volatility.

fn return_type(&self, arg_types: &[DataType]) -> Result<DataType>

[DataType] returned by this function, given the types of the arguments.

fn return_field_from_args(&self, args: ReturnFieldArgs<'_>) -> Result<FieldRef>

What type will be returned by this function, given the arguments?

fn is_nullable(&self, args: &[Expr], schema: &dyn ExprSchema) -> bool

👎Deprecated since 45.0.0: Use return_field_from_args instead. if you use is_nullable that returns non-nullable with return_type, you would need to switch to return_field_from_args, you might have error

fn invoke_with_args(&self, args: ScalarFunctionArgs) -> Result<ColumnarValue>

Invoke the function returning the appropriate result.

fn with_updated_config(&self, _config: &ConfigOptions) -> Option<ScalarUDF>

Create a new instance of this function with updated configuration.

fn aliases(&self) -> &[String]

Returns any aliases (alternate names) for this function.

fn simplify( &self, args: Vec<Expr>, info: &dyn SimplifyInfo, ) -> Result<ExprSimplifyResult>

Optionally apply per-UDF simplification / rewrite rules.

fn conditional_arguments<'a>( &self, args: &'a [Expr], ) -> Option<(Vec<&'a Expr>, Vec<&'a Expr>)>

Determines which of the arguments passed to this function are evaluated eagerly and which may be evaluated lazily.

fn short_circuits(&self) -> bool

Returns true if some of this exprs subexpressions may not be evaluated and thus any side effects (like divide by zero) may not be encountered.

fn evaluate_bounds(&self, input: &[&Interval]) -> Result<Interval>

Computes the output Interval for a ScalarUDFImpl, given the input intervals.

fn propagate_constraints( &self, interval: &Interval, inputs: &[&Interval], ) -> Result<Option<Vec<Interval>>>

Updates bounds for child expressions, given a known Intervals for this function.

fn output_ordering(&self, inputs: &[ExprProperties]) -> Result<SortProperties>

Calculates the SortProperties of this function based on its children’s properties.

fn preserves_lex_ordering(&self, inputs: &[ExprProperties]) -> Result<bool>

Returns true if the function preserves lexicographical ordering based on the input ordering.

fn coerce_types(&self, arg_types: &[DataType]) -> Result<Vec<DataType>>

Coerce arguments of a function call to types that the function can evaluate.

fn documentation(&self) -> Option<&Documentation>

Returns the documentation for this Scalar UDF.

fn lambdas_parameters( &self, args: &[ValueOrLambdaParameter<'_>], ) -> Result<Vec<Option<Vec<Field>>>>

Returns the parameters that any lambda supports

impl Eq for AliasedScalarUDFImpl

impl StructuralPartialEq for AliasedScalarUDFImpl