org.apache.flink.table.functions

Interface FunctionDefinition

All Known Implementing Classes:

AggregateFunction, AggregateFunctionDefinition, AsyncTableFunction, AvgAggFunction, AvgAggFunction.ByteAvgAggFunction, AvgAggFunction.DecimalAvgAggFunction, AvgAggFunction.DoubleAvgAggFunction, AvgAggFunction.FloatAvgAggFunction, AvgAggFunction.IntAvgAggFunction, AvgAggFunction.LongAvgAggFunction, AvgAggFunction.ShortAvgAggFunction, BuiltInFunctionDefinition, CollectAggFunction, Count1AggFunction, CountAggFunction, CsvTableSource.CsvLookupFunction, DeclarativeAggregateFunction, DenseRankAggFunction, FileSystemLookupFunction, FirstValueAggFunction, FirstValueAggFunction.BooleanFirstValueAggFunction, FirstValueAggFunction.ByteFirstValueAggFunction, FirstValueAggFunction.DecimalFirstValueAggFunction, FirstValueAggFunction.DoubleFirstValueAggFunction, FirstValueAggFunction.FloatFirstValueAggFunction, FirstValueAggFunction.IntFirstValueAggFunction, FirstValueAggFunction.LongFirstValueAggFunction, FirstValueAggFunction.ShortFirstValueAggFunction, FirstValueAggFunction.StringFirstValueAggFunction, FirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.BooleanFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.ByteFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.DecimalFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.DoubleFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.FloatFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.IntFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.LongFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.ShortFirstValueWithRetractAggFunction, FirstValueWithRetractAggFunction.StringFirstValueWithRetractAggFunction, HBaseLookupFunction, HBaseRowDataLookupFunction, HiveGenericUDAF, HiveGenericUDF, HiveGenericUDTF, HiveScalarFunction, HiveSimpleUDF, IncrSumAggFunction, IncrSumAggFunction.ByteIncrSumAggFunction, IncrSumAggFunction.DecimalIncrSumAggFunction, IncrSumAggFunction.DoubleIncrSumAggFunction, IncrSumAggFunction.FloatIncrSumAggFunction, IncrSumAggFunction.IntIncrSumAggFunction, IncrSumAggFunction.LongIncrSumAggFunction, IncrSumAggFunction.ShortIncrSumAggFunction, IncrSumWithRetractAggFunction, IncrSumWithRetractAggFunction.ByteIncrSumWithRetractAggFunction, IncrSumWithRetractAggFunction.DecimalIncrSumWithRetractAggFunction, IncrSumWithRetractAggFunction.DoubleIncrSumWithRetractAggFunction, IncrSumWithRetractAggFunction.FloatIncrSumWithRetractAggFunction, IncrSumWithRetractAggFunction.IntIncrSumWithRetractAggFunction, IncrSumWithRetractAggFunction.LongIncrSumWithRetractAggFunction, IncrSumWithRetractAggFunction.ShortIncrSumWithRetractAggFunction, JdbcLookupFunction, JdbcRowDataLookupFunction, LastValueAggFunction, LastValueAggFunction.BooleanLastValueAggFunction, LastValueAggFunction.ByteLastValueAggFunction, LastValueAggFunction.DecimalLastValueAggFunction, LastValueAggFunction.DoubleLastValueAggFunction, LastValueAggFunction.FloatLastValueAggFunction, LastValueAggFunction.IntLastValueAggFunction, LastValueAggFunction.LongLastValueAggFunction, LastValueAggFunction.ShortLastValueAggFunction, LastValueAggFunction.StringLastValueAggFunction, LastValueWithRetractAggFunction, LastValueWithRetractAggFunction.BooleanLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.ByteLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.DecimalLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.DoubleLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.FloatLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.IntLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.LongLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.ShortLastValueWithRetractAggFunction, LastValueWithRetractAggFunction.StringLastValueWithRetractAggFunction, LeadLagAggFunction, LeadLagAggFunction.BooleanLeadLagAggFunction, LeadLagAggFunction.ByteLeadLagAggFunction, LeadLagAggFunction.DateLeadLagAggFunction, LeadLagAggFunction.DecimalLeadLagAggFunction, LeadLagAggFunction.DoubleLeadLagAggFunction, LeadLagAggFunction.FloatLeadLagAggFunction, LeadLagAggFunction.IntLeadLagAggFunction, LeadLagAggFunction.LongLeadLagAggFunction, LeadLagAggFunction.ShortLeadLagAggFunction, LeadLagAggFunction.StringLeadLagAggFunction, LeadLagAggFunction.TimeLeadLagAggFunction, LeadLagAggFunction.TimestampLeadLagAggFunction, ListAggFunction, ListAggWithRetractAggFunction, ListAggWsWithRetractAggFunction, MaxAggFunction, MaxAggFunction.BooleanMaxAggFunction, MaxAggFunction.ByteMaxAggFunction, MaxAggFunction.DateMaxAggFunction, MaxAggFunction.DecimalMaxAggFunction, MaxAggFunction.DoubleMaxAggFunction, MaxAggFunction.FloatMaxAggFunction, MaxAggFunction.IntMaxAggFunction, MaxAggFunction.LongMaxAggFunction, MaxAggFunction.ShortMaxAggFunction, MaxAggFunction.StringMaxAggFunction, MaxAggFunction.TimeMaxAggFunction, MaxAggFunction.TimestampMaxAggFunction, MaxWithRetractAggFunction, MaxWithRetractAggFunction.BooleanMaxWithRetractAggFunction, MaxWithRetractAggFunction.ByteMaxWithRetractAggFunction, MaxWithRetractAggFunction.DateMaxWithRetractAggFunction, MaxWithRetractAggFunction.DecimalMaxWithRetractAggFunction, MaxWithRetractAggFunction.DoubleMaxWithRetractAggFunction, MaxWithRetractAggFunction.FloatMaxWithRetractAggFunction, MaxWithRetractAggFunction.IntMaxWithRetractAggFunction, MaxWithRetractAggFunction.LongMaxWithRetractAggFunction, MaxWithRetractAggFunction.ShortMaxWithRetractAggFunction, MaxWithRetractAggFunction.StringMaxWithRetractAggFunction, MaxWithRetractAggFunction.TimeMaxWithRetractAggFunction, MaxWithRetractAggFunction.TimestampMaxWithRetractAggFunction, MinAggFunction, MinAggFunction.BooleanMinAggFunction, MinAggFunction.ByteMinAggFunction, MinAggFunction.DateMinAggFunction, MinAggFunction.DecimalMinAggFunction, MinAggFunction.DoubleMinAggFunction, MinAggFunction.FloatMinAggFunction, MinAggFunction.IntMinAggFunction, MinAggFunction.LongMinAggFunction, MinAggFunction.ShortMinAggFunction, MinAggFunction.StringMinAggFunction, MinAggFunction.TimeMinAggFunction, MinAggFunction.TimestampMinAggFunction, MinWithRetractAggFunction, MinWithRetractAggFunction.BooleanMinWithRetractAggFunction, MinWithRetractAggFunction.ByteMinWithRetractAggFunction, MinWithRetractAggFunction.DateMinWithRetractAggFunction, MinWithRetractAggFunction.DecimalMinWithRetractAggFunction, MinWithRetractAggFunction.DoubleMinWithRetractAggFunction, MinWithRetractAggFunction.FloatMinWithRetractAggFunction, MinWithRetractAggFunction.IntMinWithRetractAggFunction, MinWithRetractAggFunction.LongMinWithRetractAggFunction, MinWithRetractAggFunction.ShortMinWithRetractAggFunction, MinWithRetractAggFunction.StringMinWithRetractAggFunction, MinWithRetractAggFunction.TimeMinWithRetractAggFunction, MinWithRetractAggFunction.TimestampMinWithRetractAggFunction, PythonScalarFunction, PythonTableFunction, RankAggFunction, RankLikeAggFunctionBase, ReplicateRows, RowNumberAggFunction, ScalarFunction, ScalarFunctionDefinition, SingleValueAggFunction, SingleValueAggFunction.BooleanSingleValueAggFunction, SingleValueAggFunction.ByteSingleValueAggFunction, SingleValueAggFunction.DateSingleValueAggFunction, SingleValueAggFunction.DecimalSingleValueAggFunction, SingleValueAggFunction.DoubleSingleValueAggFunction, SingleValueAggFunction.FloatSingleValueAggFunction, SingleValueAggFunction.IntSingleValueAggFunction, SingleValueAggFunction.LongSingleValueAggFunction, SingleValueAggFunction.ShortSingleValueAggFunction, SingleValueAggFunction.StringSingleValueAggFunction, SingleValueAggFunction.TimeSingleValueAggFunction, SingleValueAggFunction.TimestampSingleValueAggFunction, StringRegexReplaceFunction, Sum0AggFunction, Sum0AggFunction.ByteSum0AggFunction, Sum0AggFunction.DecimalSum0AggFunction, Sum0AggFunction.DoubleSum0AggFunction, Sum0AggFunction.FloatSum0AggFunction, Sum0AggFunction.IntSum0AggFunction, Sum0AggFunction.LongSum0AggFunction, Sum0AggFunction.ShortSum0AggFunction, SumAggFunction, SumAggFunction.ByteSumAggFunction, SumAggFunction.DecimalSumAggFunction, SumAggFunction.DoubleSumAggFunction, SumAggFunction.FloatSumAggFunction, SumAggFunction.IntSumAggFunction, SumAggFunction.LongSumAggFunction, SumAggFunction.ShortSumAggFunction, SumWithRetractAggFunction, SumWithRetractAggFunction.ByteSumWithRetractAggFunction, SumWithRetractAggFunction.DecimalSumWithRetractAggFunction, SumWithRetractAggFunction.DoubleSumWithRetractAggFunction, SumWithRetractAggFunction.FloatSumWithRetractAggFunction, SumWithRetractAggFunction.IntSumWithRetractAggFunction, SumWithRetractAggFunction.LongSumWithRetractAggFunction, SumWithRetractAggFunction.ShortSumWithRetractAggFunction, TableAggregateFunction, TableAggregateFunctionDefinition, TableFunction, TableFunctionDefinition, TemporalTableFunction, TemporalTableFunctionImpl, UserDefinedAggregateFunction, UserDefinedFunction

@PublicEvolving
public interface FunctionDefinition

Definition of a function. Instances of this class provide all details necessary to validate a function call and perform planning.

A pure function definition must not contain a runtime implementation. This can be provided by the planner at later stages.

See Also:

UserDefinedFunction

Method Summary

Modifier and Type	Method and Description
FunctionKind	getKind() Returns the kind of function this definition describes.
default 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.
default boolean	isDeterministic() Returns information about the determinism of the function's results.

Method Detail

getKind

FunctionKind getKind()

Returns the kind of function this definition describes.

getTypeInference

TypeInference getTypeInference(DataTypeFactory typeFactory)

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.

getRequirements

default Set<FunctionRequirement> getRequirements()

Returns the set of requirements this definition demands.

isDeterministic

default boolean isDeterministic()

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 pure functional like random(), date(), now(), ... this method must return false.