org.apache.flink.table.functions.hive

Interface HiveFunction<UDFType>

All Known Implementing Classes:

HiveGenericUDAF, HiveGenericUDF, HiveGenericUDTF, HiveScalarFunction, HiveSimpleUDF

@Internal
public interface HiveFunction<UDFType>

Interface for Hive UDF, UDTF, UDAF.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HiveFunction.HiveFunctionInputStrategy InputTypeStrategy for Hive UDF, UDTF, UDAF.
static class	HiveFunction.HiveFunctionOutputStrategy OutputTypeStrategy for Hive UDF, UDTF, UDAF.

Method Summary

Modifier and Type	Method and Description
default TypeInference	createTypeInference() Creates TypeInference for the function.
HiveFunctionWrapper<UDFType>	getFunctionWrapper() Gets the wrapper for the Hive function.
DataType	inferReturnType() Infers the return type of the function.
void	setArguments(CallContext callContext) Sets input arguments for the function.

Method Detail

setArguments

void setArguments(CallContext callContext)

Sets input arguments for the function.

inferReturnType

DataType inferReturnType()
                  throws org.apache.hadoop.hive.ql.exec.UDFArgumentException

Infers the return type of the function. This method should be called after setArguments(CallContext) is called.

Returns:

The inferred return type.

Throws:

org.apache.hadoop.hive.ql.exec.UDFArgumentException - can be thrown if the input arguments are invalid.

getFunctionWrapper

HiveFunctionWrapper<UDFType> getFunctionWrapper()

Gets the wrapper for the Hive function.

createTypeInference

default TypeInference createTypeInference()

Creates TypeInference for the function.