@PublicEvolving public abstract class ScalarFunction extends UserDefinedFunction
The behavior of a
ScalarFunction can be defined by implementing a custom evaluation
method. An evaluation method must be declared publicly and named
methods can also be overloaded by implementing multiple methods named
User-defined functions must have a default constructor and must be instantiable during runtime.
By default the result type of an evaluation method is determined by Flink's type extraction
facilities. This is sufficient for basic types or simple POJOs but might be wrong for more
complex, custom, or composite types. In these cases
TypeInformation of the result type
can be manually defined by overriding
Internally, the Table/SQL API code generation works with primitive values as much as possible.
If a user-defined scalar function should not introduce much overhead during runtime, it is
recommended to declare parameters and result types as primitive types instead of their boxed
DATE/TIME is equal to
TIMESTAMP is equal
|Constructor and Description|
|Modifier and Type||Method and Description|
Returns the kind of function this definition describes.
Returns the result type of the evaluation method with a given signature.
close, functionIdentifier, open, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public TypeInformation<?> getResultType(Class<?> signature)
This method needs to be overridden in case Flink's type extraction facilities are not
sufficient to extract the
TypeInformation based on the return type of the evaluation
method. Flink's type extraction facilities can handle basic types or
simple POJOs but might be wrong for more complex, custom, or composite types.
signature- signature of the method the return type needs to be determined
TypeInformationof result type or
nullif Flink should determine the type
public TypeInformation<?> getParameterTypes(Class<?> signature)
TypeInformationabout the operands of the evaluation method with a given signature.
In order to perform operand type inference in SQL (especially when
used) it might be necessary to determine the parameter
TypeInformation of an
evaluation method. By default Flink's type extraction facilities are used for this but might
be wrong for more complex, custom, or composite types.
signature- signature of the method the operand types need to be determined
TypeInformationof operand types
public final FunctionKind getKind()
Copyright © 2014–2020 The Apache Software Foundation. All rights reserved.