org.apache.hadoop.hive.ql.exec

Class FunctionRegistry

java.lang.Object

org.apache.hadoop.hive.ql.exec.FunctionRegistry

public final class FunctionRegistry
extends Object

FunctionRegistry.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	HIVE_OPERATORS
static String	LAG_FUNC_NAME
static String	LAST_VALUE_FUNC_NAME
static String	LEAD_FUNC_NAME
static String	UNARY_MINUS_FUNC_NAME
static String	UNARY_PLUS_FUNC_NAME
static String	WINDOWING_TABLE_FUNCTION

Method Summary

Methods

Modifier and Type	Method and Description
static GenericUDF	cloneGenericUDF(GenericUDF genericUDF) Create a copy of an existing GenericUDF.
static GenericUDTF	cloneGenericUDTF(GenericUDTF genericUDTF) Create a copy of an existing GenericUDTF.
static PrimitiveObjectInspector.PrimitiveCategory	getCommonCategory(TypeInfo a, TypeInfo b)
static TypeInfo	getCommonClass(TypeInfo a, TypeInfo b) Find a common class that objects of both TypeInfo a and TypeInfo b can convert to.
static TypeInfo	getCommonClassForComparison(TypeInfo a, TypeInfo b) Find a common class that objects of both TypeInfo a and TypeInfo b can convert to.
static TypeInfo	getCommonClassForUnionAll(TypeInfo a, TypeInfo b) Find a common class for union-all operator
static FunctionInfo	getFunctionInfo(String functionName)
static Set<String>	getFunctionNames()
static Set<String>	getFunctionNames(String funcPatternStr)
static Set<String>	getFunctionNamesByLikePattern(String funcPatternStr) Returns a set of registered function names which matchs the given pattern.
static Set<String>	getFunctionSynonyms(String funcName) Returns the set of synonyms of the supplied function.
static GenericUDAFEvaluator	getGenericUDAFEvaluator(String name, List<ObjectInspector> argumentOIs, boolean isDistinct, boolean isAllColumns) Get the GenericUDAF evaluator for the name and argumentClasses.
static GenericUDAFResolver	getGenericUDAFResolver(String functionName)
static GenericUDF	getGenericUDFForAnd() A shortcut to get the "and" GenericUDF.
static GenericUDF	getGenericUDFForIndex() A shortcut to get the "index" GenericUDF.
static GenericUDAFEvaluator	getGenericWindowingEvaluator(String name, List<ObjectInspector> argumentOIs, boolean isDistinct, boolean isAllColumns)
static Method	getMethodInternal(Class<?> udfClass, List<Method> mlist, boolean exact, List<TypeInfo> argumentsPassed) Gets the closest matching method corresponding to the argument list from a list of methods.
static <T> Method	getMethodInternal(Class<? extends T> udfClass, String methodName, boolean exact, List<TypeInfo> argumentClasses) This method is shared between UDFRegistry and UDAFRegistry.
static String	getNormalizedFunctionName(String fn)
static TableFunctionResolver	getTableFunctionResolver(String functionName)
static FunctionInfo	getTemporaryFunctionInfo(String functionName)
static TypeInfo	getTypeInfoForPrimitiveCategory(PrimitiveTypeInfo a, PrimitiveTypeInfo b, PrimitiveObjectInspector.PrimitiveCategory typeCategory) Given 2 TypeInfo types and the PrimitiveCategory selected as the common class between the two, return a TypeInfo corresponding to the common PrimitiveCategory, and with type qualifiers (if applicable) that match the 2 TypeInfo types.
static WindowFunctionInfo	getWindowFunctionInfo(String functionName)
static TableFunctionResolver	getWindowingTableFunction()
static boolean	implicitConvertible(PrimitiveObjectInspector.PrimitiveCategory from, PrimitiveObjectInspector.PrimitiveCategory to)
static boolean	implicitConvertible(TypeInfo from, TypeInfo to) Returns whether it is possible to implicitly convert an object of Class from to Class to.
static boolean	impliesOrder(String functionName) Both UDF and UDAF functions can imply order for analytical functions
static Object	invoke(Method m, Object thisObject, Object... arguments)
static boolean	isBuiltInFuncExpr(ExprNodeGenericFuncDesc fnExpr)
static boolean	isDeterministic(GenericUDF genericUDF) Returns whether a GenericUDF is deterministic or not.
static boolean	isExactNumericType(PrimitiveTypeInfo typeInfo) Check if a type is exact (not approximate such as float and double).
static boolean	isNoopFunction(String fnName)
static boolean	isNumericType(PrimitiveTypeInfo typeInfo) Check if the given type is numeric.
static boolean	isOpAnd(ExprNodeDesc desc) Returns whether the exprNodeDesc is a node of "and".
static boolean	isOpAndOrNot(ExprNodeDesc desc) Returns whether the exprNodeDesc is a node of "and", "or", "not".
static boolean	isOpCast(ExprNodeDesc desc) Returns whether the exprNodeDesc is node of "cast".
static boolean	isOpCast(GenericUDF genericUDF)
static boolean	isOpNot(ExprNodeDesc desc) Returns whether the exprNodeDesc is a node of "not".
static boolean	isOpOr(ExprNodeDesc desc) Returns whether the exprNodeDesc is a node of "or".
static boolean	isOpPositive(ExprNodeDesc desc) Returns whether the exprNodeDesc is a node of "positive".
static boolean	isOpPreserveInputName(ExprNodeDesc desc) Returns whether the exprNodeDesc can recommend name for the expression
static boolean	isRankingFunction(String name) Use this to check if function is ranking function
static boolean	isStateful(GenericUDF genericUDF) Returns whether a GenericUDF is stateful or not.
static boolean	isTableFunction(String functionName)
static int	matchCost(TypeInfo argumentPassed, TypeInfo argumentAccepted, boolean exact) Returns -1 if passed does not match accepted.
static boolean	pivotResult(String functionName)
static FunctionInfo	registerPermanentFunction(String functionName, String className, boolean registerToSession, FunctionInfo.FunctionResource[] resources)
static void	registerTemporaryMacro(String macroName, ExprNodeDesc body, List<String> colNames, List<TypeInfo> colTypes) Registers the appropriate kind of temporary function based on a class's type.
static FunctionInfo	registerTemporaryUDF(String functionName, Class<?> udfClass, FunctionInfo.FunctionResource... resources) Registers the appropriate kind of temporary function based on a class's type.
static void	setupPermissionsForBuiltinUDFs(String whiteListStr, String blackListStr) Setup blocked flag for all builtin UDFs as per udf whitelist and blacklist
static void	unregisterPermanentFunction(String functionName)
static void	unregisterTemporaryUDF(String functionName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LEAD_FUNC_NAME

public static final String LEAD_FUNC_NAME

See Also:

Constant Field Values

LAG_FUNC_NAME

public static final String LAG_FUNC_NAME

See Also:

Constant Field Values

LAST_VALUE_FUNC_NAME

public static final String LAST_VALUE_FUNC_NAME

See Also:

Constant Field Values

UNARY_PLUS_FUNC_NAME

public static final String UNARY_PLUS_FUNC_NAME

See Also:

Constant Field Values

UNARY_MINUS_FUNC_NAME

public static final String UNARY_MINUS_FUNC_NAME

See Also:

Constant Field Values

WINDOWING_TABLE_FUNCTION

public static final String WINDOWING_TABLE_FUNCTION

See Also:

Constant Field Values

HIVE_OPERATORS

public static final Set<String> HIVE_OPERATORS

Method Detail

getNormalizedFunctionName

public static String getNormalizedFunctionName(String fn)
                                        throws SemanticException

Throws:

SemanticException

getFunctionInfo

public static FunctionInfo getFunctionInfo(String functionName)
                                    throws SemanticException

Throws:

SemanticException

getTemporaryFunctionInfo

public static FunctionInfo getTemporaryFunctionInfo(String functionName)
                                             throws SemanticException

Throws:

SemanticException

getWindowFunctionInfo

public static WindowFunctionInfo getWindowFunctionInfo(String functionName)
                                                throws SemanticException

Throws:

SemanticException

getFunctionNames

public static Set<String> getFunctionNames()

getFunctionNames

public static Set<String> getFunctionNames(String funcPatternStr)

getFunctionNamesByLikePattern

public static Set<String> getFunctionNamesByLikePattern(String funcPatternStr)

Returns a set of registered function names which matchs the given pattern. This is used for the CLI command "SHOW FUNCTIONS LIKE 'regular expression';"

Parameters:

funcPatternStr - regular expression of the interested function names

Returns:

set of strings contains function names

getFunctionSynonyms

public static Set<String> getFunctionSynonyms(String funcName)
                                       throws SemanticException

Returns the set of synonyms of the supplied function.

Parameters:

funcName - the name of the function

Returns:

Set of synonyms for funcName

Throws:

SemanticException

isNumericType

public static boolean isNumericType(PrimitiveTypeInfo typeInfo)

Check if the given type is numeric. String is considered numeric when used in numeric operators.

Parameters:

typeInfo -

Returns:

isExactNumericType

public static boolean isExactNumericType(PrimitiveTypeInfo typeInfo)

Check if a type is exact (not approximate such as float and double). String is considered as double, thus not exact.

Parameters:

typeInfo -

Returns:

getTypeInfoForPrimitiveCategory

public static TypeInfo getTypeInfoForPrimitiveCategory(PrimitiveTypeInfo a,
                                       PrimitiveTypeInfo b,
                                       PrimitiveObjectInspector.PrimitiveCategory typeCategory)

Given 2 TypeInfo types and the PrimitiveCategory selected as the common class between the two, return a TypeInfo corresponding to the common PrimitiveCategory, and with type qualifiers (if applicable) that match the 2 TypeInfo types. Examples: varchar(10), varchar(20), primitive category varchar => varchar(20) date, string, primitive category string => string

Parameters:

a - TypeInfo of the first type

b - TypeInfo of the second type

typeCategory - PrimitiveCategory of the designated common type between a and b

Returns:

TypeInfo represented by the primitive category, with any applicable type qualifiers.

getCommonClassForUnionAll

public static TypeInfo getCommonClassForUnionAll(TypeInfo a,
                                 TypeInfo b)

Find a common class for union-all operator

getCommonClassForComparison

public static TypeInfo getCommonClassForComparison(TypeInfo a,
                                   TypeInfo b)

Find a common class that objects of both TypeInfo a and TypeInfo b can convert to. This is used for comparing objects of type a and type b. When we are comparing string and double, we will always convert both of them to double and then compare.

Returns:

null if no common class could be found.

getCommonCategory

public static PrimitiveObjectInspector.PrimitiveCategory getCommonCategory(TypeInfo a,
                                                           TypeInfo b)

getCommonClass

public static TypeInfo getCommonClass(TypeInfo a,
                      TypeInfo b)

Find a common class that objects of both TypeInfo a and TypeInfo b can convert to. This is used for places other than comparison. The common class of string and double is string.

Returns:

null if no common class could be found.

implicitConvertible

public static boolean implicitConvertible(PrimitiveObjectInspector.PrimitiveCategory from,
                          PrimitiveObjectInspector.PrimitiveCategory to)

implicitConvertible

public static boolean implicitConvertible(TypeInfo from,
                          TypeInfo to)

Returns whether it is possible to implicitly convert an object of Class from to Class to.

getGenericUDAFEvaluator

public static GenericUDAFEvaluator getGenericUDAFEvaluator(String name,
                                           List<ObjectInspector> argumentOIs,
                                           boolean isDistinct,
                                           boolean isAllColumns)
                                                    throws SemanticException

Get the GenericUDAF evaluator for the name and argumentClasses.

Parameters:

name - the name of the UDAF

argumentOIs -

isDistinct -

isAllColumns -

Returns:

The UDAF evaluator

Throws:

SemanticException

getGenericWindowingEvaluator

public static GenericUDAFEvaluator getGenericWindowingEvaluator(String name,
                                                List<ObjectInspector> argumentOIs,
                                                boolean isDistinct,
                                                boolean isAllColumns)
                                                         throws SemanticException

Throws:

SemanticException

getMethodInternal

public static <T> Method getMethodInternal(Class<? extends T> udfClass,
                           String methodName,
                           boolean exact,
                           List<TypeInfo> argumentClasses)
                                throws UDFArgumentException

This method is shared between UDFRegistry and UDAFRegistry. methodName will be "evaluate" for UDFRegistry, and "aggregate"/"evaluate"/"evaluatePartial" for UDAFRegistry.

Throws:

UDFArgumentException

getGenericUDAFResolver

public static GenericUDAFResolver getGenericUDAFResolver(String functionName)
                                                  throws SemanticException

Throws:

SemanticException

invoke

public static Object invoke(Method m,
            Object thisObject,
            Object... arguments)
                     throws HiveException

Throws:

HiveException

matchCost

public static int matchCost(TypeInfo argumentPassed,
            TypeInfo argumentAccepted,
            boolean exact)

Returns -1 if passed does not match accepted. Otherwise return the cost (usually 0 for no conversion and 1 for conversion).

getMethodInternal

public static Method getMethodInternal(Class<?> udfClass,
                       List<Method> mlist,
                       boolean exact,
                       List<TypeInfo> argumentsPassed)
                                throws UDFArgumentException

Gets the closest matching method corresponding to the argument list from a list of methods.

Parameters:

mlist - The list of methods to inspect.

exact - Boolean to indicate whether this is an exact match or not.

argumentsPassed - The classes for the argument.

Returns:

The matching method.

Throws:

UDFArgumentException

getGenericUDFForIndex

public static GenericUDF getGenericUDFForIndex()

A shortcut to get the "index" GenericUDF. This is used for getting elements out of array and getting values out of map.

Throws:

SemanticException

getGenericUDFForAnd

public static GenericUDF getGenericUDFForAnd()

A shortcut to get the "and" GenericUDF.

Throws:

SemanticException

cloneGenericUDF

public static GenericUDF cloneGenericUDF(GenericUDF genericUDF)

Create a copy of an existing GenericUDF.

cloneGenericUDTF

public static GenericUDTF cloneGenericUDTF(GenericUDTF genericUDTF)

Create a copy of an existing GenericUDTF.

isDeterministic

public static boolean isDeterministic(GenericUDF genericUDF)

Returns whether a GenericUDF is deterministic or not.

isStateful

public static boolean isStateful(GenericUDF genericUDF)

Returns whether a GenericUDF is stateful or not.

isOpAndOrNot

public static boolean isOpAndOrNot(ExprNodeDesc desc)

Returns whether the exprNodeDesc is a node of "and", "or", "not".

isOpAnd

public static boolean isOpAnd(ExprNodeDesc desc)

Returns whether the exprNodeDesc is a node of "and".

isOpOr

public static boolean isOpOr(ExprNodeDesc desc)

Returns whether the exprNodeDesc is a node of "or".

isOpNot

public static boolean isOpNot(ExprNodeDesc desc)

Returns whether the exprNodeDesc is a node of "not".

isOpPositive

public static boolean isOpPositive(ExprNodeDesc desc)

Returns whether the exprNodeDesc is a node of "positive".

isOpCast

public static boolean isOpCast(ExprNodeDesc desc)

Returns whether the exprNodeDesc is node of "cast".

isOpCast

public static boolean isOpCast(GenericUDF genericUDF)

isOpPreserveInputName

public static boolean isOpPreserveInputName(ExprNodeDesc desc)

Returns whether the exprNodeDesc can recommend name for the expression

registerTemporaryUDF

public static FunctionInfo registerTemporaryUDF(String functionName,
                                Class<?> udfClass,
                                FunctionInfo.FunctionResource... resources)

Registers the appropriate kind of temporary function based on a class's type.

Parameters:

functionName - name under which to register function

udfClass - class implementing UD[A|T]F

Returns:

true if udfClass's type was recognized (so registration succeeded); false otherwise

unregisterTemporaryUDF

public static void unregisterTemporaryUDF(String functionName)
                                   throws HiveException

Throws:

HiveException

registerTemporaryMacro

public static void registerTemporaryMacro(String macroName,
                          ExprNodeDesc body,
                          List<String> colNames,
                          List<TypeInfo> colTypes)

Registers the appropriate kind of temporary function based on a class's type.

Parameters:

macroName - name under which to register the macro

body - the expression which the macro evaluates to

colNames - the names of the arguments to the macro

colTypes - the types of the arguments to the macro

registerPermanentFunction

public static FunctionInfo registerPermanentFunction(String functionName,
                                     String className,
                                     boolean registerToSession,
                                     FunctionInfo.FunctionResource[] resources)

unregisterPermanentFunction

public static void unregisterPermanentFunction(String functionName)
                                        throws HiveException

Throws:

HiveException

impliesOrder

public static boolean impliesOrder(String functionName)
                            throws SemanticException

Both UDF and UDAF functions can imply order for analytical functions

Parameters:

functionName - name of function

Returns:

true if a GenericUDF or GenericUDAF exists for this name and implyOrder is true, false otherwise.

Throws:

SemanticException

pivotResult

public static boolean pivotResult(String functionName)
                           throws SemanticException

Throws:

SemanticException

isTableFunction

public static boolean isTableFunction(String functionName)
                               throws SemanticException

Throws:

SemanticException

getTableFunctionResolver

public static TableFunctionResolver getTableFunctionResolver(String functionName)
                                                      throws SemanticException

Throws:

SemanticException

getWindowingTableFunction

public static TableFunctionResolver getWindowingTableFunction()
                                                       throws SemanticException

Throws:

SemanticException

isNoopFunction

public static boolean isNoopFunction(String fnName)

isRankingFunction

public static boolean isRankingFunction(String name)
                                 throws SemanticException

Use this to check if function is ranking function

Parameters:

name - name of a function

Returns:

true if function is a UDAF, has WindowFunctionDescription annotation and the annotations confirms a ranking function, false otherwise

Throws:

SemanticException

isBuiltInFuncExpr

public static boolean isBuiltInFuncExpr(ExprNodeGenericFuncDesc fnExpr)

Parameters:

fnExpr - Function expression.

Returns:

True iff the fnExpr represents a hive built-in function (native, non-permanent)

setupPermissionsForBuiltinUDFs

public static void setupPermissionsForBuiltinUDFs(String whiteListStr,
                                  String blackListStr)

Setup blocked flag for all builtin UDFs as per udf whitelist and blacklist

Parameters:

whiteList -

blackList -