@PublicEvolving public interface FunctionDefinition
A pure function definition doesn't have to contain a runtime implementation. This can be
provided by the planner at later stages. A
UserDefinedFunction is a function definition
that includes a runtime implementation already.
|Modifier and Type||Method and Description|
Returns the kind of function this definition describes.
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.
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.
default Set<FunctionRequirement> getRequirements()
default 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.