Package org.apache.flink.table.functions

Class ScalarFunctionDefinition

java.lang.Object
org.apache.flink.table.functions.ScalarFunctionDefinition
All Implemented Interfaces:
FunctionDefinition
@Deprecated @Internal public final class ScalarFunctionDefinition extends Object implements FunctionDefinition
Deprecated.
Non-legacy functions can simply omit this wrapper for declarations.
A "marker" function definition of a user-defined scalar function that uses the old type system stack.

This class can be dropped once we introduce a new type inference.

  • Constructor Details

    • ScalarFunctionDefinition

      public ScalarFunctionDefinition(String name, ScalarFunction scalarFunction)
      Deprecated.

  • Method Details

    • getName

      public String getName()
      Deprecated.

    • getScalarFunction

      public ScalarFunction getScalarFunction()
      Deprecated.

    • getKind

      public FunctionKind getKind()
      Deprecated.
      Description copied from interface: FunctionDefinition
      Returns the kind of function this definition describes.
      Specified by:
      getKind in interface FunctionDefinition

    • getTypeInference

      public TypeInference getTypeInference(DataTypeFactory factory)
      Deprecated.
      Description copied from interface: FunctionDefinition
      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.

      Specified by:
      getTypeInference in interface FunctionDefinition

    • getRequirements

      public Set<FunctionRequirement> getRequirements()
      Deprecated.
      Description copied from interface: FunctionDefinition
      Returns the set of requirements this definition demands.
      Specified by:
      getRequirements in interface FunctionDefinition

    • isDeterministic

      public boolean isDeterministic()
      Deprecated.
      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.

      Specified by:
      isDeterministic in interface FunctionDefinition

    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object