@Internal public abstract class BuiltInScalarFunction extends ScalarFunction
ScalarFunctionthat is constructed from
Subclasses must offer a constructor that takes
SpecializedFunction.SpecializedContext if they are
constructed from a
BuiltInFunctionDefinition. Otherwise the
BuiltInScalarFunction() constructor might be more appropriate.
By default, all built-in functions work on internal data structures. However, this can be
changed by overriding
getOutputDataType(). Or by
|Modifier||Constructor and Description|
|Modifier and Type||Method and Description|
Returns the set of requirements this definition demands.
Returns the logic for performing type inference of a call to this function definition.
Returns information about the determinism of the function's results.
getKind, getParameterTypes, getResultType
close, functionIdentifier, open, toString
protected BuiltInScalarFunction(BuiltInFunctionDefinition definition, SpecializedFunction.SpecializedContext context)
public DataType getOutputDataType()
public TypeInference getTypeInference(DataTypeFactory typeFactory)
The type inference process is responsible for inferring unknown types of input arguments, validating input arguments, and producing result types. The type inference process happens independent of a function body. The output of the type inference is used to search for a corresponding runtime implementation.
Instances of type inference can be created by using
BuiltInFunctionDefinitions for concrete usage examples.
The type inference for user-defined functions is automatically extracted using reflection.
It does this by analyzing implementation methods such as
eval() or accumulate() and
the generic parameters of a function class if present. If the reflective information is not
sufficient, it can be supported and enriched with
Note: Overriding this method is only recommended for advanced users. If a custom type inference is specified, it is the responsibility of the implementer to make sure that the output of the type inference process matches with the implementation method:
The implementation method must comply with each
returned by the type inference. For example, if
DataTypes.TIMESTAMP(3).bridgedTo(java.sql.Timestamp.class) is an expected argument type, the
method must accept a call
Regular Java calling semantics (including type widening and autoboxing) are applied when
calling an implementation method which means that the signature can be
The runtime will take care of converting the data to the data format specified by the
DataType.getConversionClass() coming from the type inference logic.
public Set<FunctionRequirement> getRequirements()
public boolean isDeterministic()
true if and only if a call to this function is guaranteed to
always return the same result given the same parameters.
true is assumed by
default. If the function is not purely functional like
random(), date(), now(), ...
this method must return
false if the planner should always execute this function
on the cluster side. In other words: the planner should not perform constant expression
reduction during planning for constant calls to this function.
Copyright © 2014–2023 The Apache Software Foundation. All rights reserved.