Interface SpecializedFunction

  • All Superinterfaces:
    FunctionDefinition
    All Known Implementing Classes:
    BuiltInFunctionDefinition

    @PublicEvolving
    public interface SpecializedFunction
    extends FunctionDefinition
    A FunctionDefinition that can provide a runtime implementation (i.e. the function's body) that is specialized for the given call and session.

    The planner tries to defer the specialization until shortly before code generation, where the information given by a FunctionDefinition is not enough anymore and a subclass of UserDefinedFunction is required for runtime.

    This interface is useful when the runtime code should know about information that is only available after planning (e.g. local session time zone or precision/scale of decimal return type).

    A UserDefinedFunction that is registered in the API is implicitly specialized but can also implement this interface to reconfigure itself before runtime.

    Note: This interface is a rather low level kind of function but useful for advanced users.