Package org.apache.flink.table.runtime.functions.scalar

Class BuiltInScalarFunction

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunction

org.apache.flink.table.functions.ScalarFunction

org.apache.flink.table.runtime.functions.scalar.BuiltInScalarFunction

All Implemented Interfaces:

Serializable, FunctionDefinition

Direct Known Subclasses:

ArrayAppendFunction, ArrayConcatFunction, ArrayContainsFunction, ArrayDistinctFunction, ArrayExceptFunction, ArrayIntersectFunction, ArrayJoinFunction, ArrayMaxFunction, ArrayMinFunction, ArrayPositionFunction, ArrayPrependFunction, ArrayRemoveFunction, ArrayReverseFunction, ArraySliceFunction, ArraySortFunction, ArrayUnionFunction, BTrimFunction, CoalesceFunction, EltFunction, EndsWithFunction, IfNullFunction, JsonQuoteFunction, JsonUnquoteFunction, MapEntriesFunction, MapFromArraysFunction, MapKeysFunction, MapUnionFunction, MapValuesFunction, PrintfFunction, RegexpCountFunction, RegexpExtractAllFunction, RegexpInstrFunction, RegexpSubstrFunction, SourceWatermarkFunction, SplitFunction, StartsWithFunction, TranslateFunction, TypeOfFunction, UnhexFunction, UrlDecodeFunction, UrlEncodeFunction

@Internal
public abstract class BuiltInScalarFunction
extends ScalarFunction

Base class for runtime implementation represented as ScalarFunction that is constructed from BuiltInFunctionDefinition.specialize(SpecializedContext).

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 getArgumentDataTypes() and getOutputDataType(). Or by overriding getTypeInference(DataTypeFactory) directly.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuiltInScalarFunction()
protected	BuiltInScalarFunction(BuiltInFunctionDefinition definition, SpecializedFunction.SpecializedContext context)

Method Summary

Modifier and Type	Method	Description
List<DataType>	getArgumentDataTypes()
DataType	getOutputDataType()
Set<FunctionRequirement>	getRequirements()	Returns the set of requirements this definition demands.
TypeInference	getTypeInference(DataTypeFactory typeFactory)	Returns the logic for performing type inference of a call to this function definition.
boolean	isDeterministic()	Returns information about the determinism of the function's results.

Methods inherited from class org.apache.flink.table.functions.ScalarFunction

getKind, getParameterTypes, getResultType

Methods inherited from class org.apache.flink.table.functions.UserDefinedFunction

close, functionIdentifier, open, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flink.table.functions.FunctionDefinition

supportsConstantFolding

Constructor Detail

BuiltInScalarFunction

protected BuiltInScalarFunction(BuiltInFunctionDefinition definition,
                                SpecializedFunction.SpecializedContext context)

BuiltInScalarFunction

protected BuiltInScalarFunction()

Method Detail

getArgumentDataTypes

public List<DataType> getArgumentDataTypes()

getOutputDataType

public DataType getOutputDataType()

getTypeInference

public TypeInference getTypeInference(DataTypeFactory typeFactory)

Description copied from class: UserDefinedFunction

Returns the logic for performing type inference of a call to this function definition.

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 TypeInference.newBuilder().

See 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 DataTypeHint and FunctionHint annotations.

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 DataType.getConversionClass() 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 eval(java.sql.Timestamp).

Regular Java calling semantics (including type widening and autoboxing) are applied when calling an implementation method which means that the signature can be eval(java.lang.Object).

The runtime will take care of converting the data to the data format specified by the DataType.getConversionClass() coming from the type inference logic.

Specified by:

getTypeInference in interface FunctionDefinition

Overrides:

getTypeInference in class ScalarFunction

getRequirements

public Set<FunctionRequirement> getRequirements()

Description copied from interface: FunctionDefinition

Returns the set of requirements this definition demands.

isDeterministic

public boolean isDeterministic()

Description copied from interface: FunctionDefinition

Returns information about the determinism of the function's results.

It returns 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.

Furthermore, 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.