org.apache.flink.table.functions.hive

Class HiveGenericUDTF

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunction

org.apache.flink.table.functions.TableFunction<Row>

org.apache.flink.table.functions.hive.HiveGenericUDTF

All Implemented Interfaces:

Serializable, FunctionDefinition, HiveFunction<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF>

@Internal
public class HiveGenericUDTF
extends TableFunction<Row>
implements HiveFunction<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF>

A TableFunction implementation that calls Hive's GenericUDTF.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.functions.hive.HiveFunction

HiveFunction.HiveFunctionInputStrategy, HiveFunction.HiveFunctionOutputStrategy

Constructor Summary

Constructors

Constructor and Description
HiveGenericUDTF(HiveFunctionWrapper<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF> hiveFunctionWrapper, HiveShim hiveShim)

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for user-defined function.
void	eval(Object... args)
HiveFunctionWrapper<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF>	getFunctionWrapper() Gets the wrapper for the Hive function.
static org.apache.hadoop.hive.serde2.objectinspector.StandardStructObjectInspector	getStandardStructObjectInspector(org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector[] argumentInspectors)
TypeInference	getTypeInference(DataTypeFactory typeFactory) Returns the logic for performing type inference of a call to this function definition.
DataType	inferReturnType() Infers the return type of the function.
void	open(FunctionContext context) Setup method for user-defined function.
void	setArguments(CallContext callContext) Sets input arguments for the function.
protected void	setCollector(org.apache.hadoop.hive.ql.udf.generic.Collector collector)

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

collect, finish, getKind, getParameterTypes, getResultType, setCollector

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

functionIdentifier, 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.hive.HiveFunction

createTypeInference

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

getRequirements, isDeterministic, supportsConstantFolding

Constructor Detail

HiveGenericUDTF

public HiveGenericUDTF(HiveFunctionWrapper<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF> hiveFunctionWrapper,
                       HiveShim hiveShim)

Method Detail

open

public void open(FunctionContext context)
          throws Exception

Description copied from class: UserDefinedFunction

Setup method for user-defined function. It can be used for initialization work. By default, this method does nothing.

Overrides:

open in class UserDefinedFunction

Throws:

Exception

setCollector

@VisibleForTesting
protected final void setCollector(org.apache.hadoop.hive.ql.udf.generic.Collector collector)

eval

public void eval(Object... args)
          throws org.apache.hadoop.hive.ql.metadata.HiveException

Throws:

org.apache.hadoop.hive.ql.metadata.HiveException

close

public void close()
           throws Exception

Description copied from class: UserDefinedFunction

Tear-down method for user-defined function. It can be used for clean up work. By default, this method does nothing.

Overrides:

close in class UserDefinedFunction

Throws:

Exception

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 TableFunction<Row>

setArguments

public void setArguments(CallContext callContext)

Description copied from interface: HiveFunction

Sets input arguments for the function.

Specified by:

setArguments in interface HiveFunction<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF>

inferReturnType

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

Description copied from interface: HiveFunction

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

Specified by:

inferReturnType in interface HiveFunction<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF>

Returns:

The inferred return type.

Throws:

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

getFunctionWrapper

public HiveFunctionWrapper<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF> getFunctionWrapper()

Description copied from interface: HiveFunction

Gets the wrapper for the Hive function.

Specified by:

getFunctionWrapper in interface HiveFunction<org.apache.hadoop.hive.ql.udf.generic.GenericUDTF>

getStandardStructObjectInspector

public static org.apache.hadoop.hive.serde2.objectinspector.StandardStructObjectInspector getStandardStructObjectInspector(org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector[] argumentInspectors)