org.apache.hadoop.hive.ql.exec

Class Registry

java.lang.Object

org.apache.hadoop.hive.ql.exec.Registry

public class Registry
extends Object

Constructor Summary

Constructors

Constructor and Description
Registry()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToUDFLoaders(ClassLoader loader)
void	clear()
void	closeCUDFLoaders()
Set<String>	getCurrentFunctionNames()
FunctionInfo	getFunctionInfo(String functionName) Looks up the function name in the registry.
Set<String>	getFunctionNames(Pattern funcPattern) Returns a set of registered function names.
Set<String>	getFunctionNames(String funcPatternStr)
void	getFunctionSynonyms(String funcName, FunctionInfo funcInfo, Set<String> synonyms) Adds to the set of synonyms of the supplied function.
GenericUDAFEvaluator	getGenericUDAFEvaluator(String name, List<ObjectInspector> argumentOIs, boolean isDistinct, boolean isAllColumns) Get the GenericUDAF evaluator for the name and argumentClasses.
GenericUDAFResolver	getGenericUDAFResolver(String functionName)
GenericUDAFEvaluator	getGenericWindowingEvaluator(String functionName, List<ObjectInspector> argumentOIs, boolean isDistinct, boolean isAllColumns)
WindowFunctionInfo	getWindowFunctionInfo(String functionName)
boolean	isBuiltInFunc(Class<?> udfClass)
FunctionInfo	registerFunction(String functionName, Class<?> udfClass, FunctionInfo.FunctionResource... resources) Registers the appropriate kind of temporary function based on a class's type.
FunctionInfo	registerGenericUDAF(String functionName, GenericUDAFResolver genericUDAFResolver, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerGenericUDF(String functionName, Class<? extends GenericUDF> genericUDFClass, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerGenericUDTF(String functionName, Class<? extends GenericUDTF> genericUDTFClass, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerMacro(String macroName, ExprNodeDesc body, List<String> colNames, List<TypeInfo> colTypes)
FunctionInfo	registerMacro(String macroName, ExprNodeDesc body, List<String> colNames, List<TypeInfo> colTypes, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerPermanentFunction(String functionName, String className, boolean registerToSession, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerTableFunction(String functionName, Class<? extends TableFunctionResolver> tFnCls, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerUDAF(String functionName, Class<? extends UDAF> udafClass, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerUDF(String functionName, Class<? extends UDF> UDFClass, boolean isOperator, FunctionInfo.FunctionResource... resources)
FunctionInfo	registerUDF(String functionName, Class<? extends UDF> UDFClass, boolean isOperator, String displayName, FunctionInfo.FunctionResource... resources)
void	removeFromUDFLoaders(ClassLoader loader)
void	setupPermissionsForUDFs(String whiteListStr, String blackListStr) Setup blocked flag for all builtin UDFs as per udf whitelist and blacklist
void	unregisterFunction(String functionName)

Methods inherited from class java.lang.Object

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

Constructor Detail

Registry

public Registry()

Method Detail

registerFunction

public FunctionInfo registerFunction(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

registerUDF

public FunctionInfo registerUDF(String functionName,
                       Class<? extends UDF> UDFClass,
                       boolean isOperator,
                       FunctionInfo.FunctionResource... resources)

registerUDF

public FunctionInfo registerUDF(String functionName,
                       Class<? extends UDF> UDFClass,
                       boolean isOperator,
                       String displayName,
                       FunctionInfo.FunctionResource... resources)

registerGenericUDF

public FunctionInfo registerGenericUDF(String functionName,
                              Class<? extends GenericUDF> genericUDFClass,
                              FunctionInfo.FunctionResource... resources)

registerGenericUDTF

public FunctionInfo registerGenericUDTF(String functionName,
                               Class<? extends GenericUDTF> genericUDTFClass,
                               FunctionInfo.FunctionResource... resources)

registerGenericUDAF

public FunctionInfo registerGenericUDAF(String functionName,
                               GenericUDAFResolver genericUDAFResolver,
                               FunctionInfo.FunctionResource... resources)

registerUDAF

public FunctionInfo registerUDAF(String functionName,
                        Class<? extends UDAF> udafClass,
                        FunctionInfo.FunctionResource... resources)

registerTableFunction

public FunctionInfo registerTableFunction(String functionName,
                                 Class<? extends TableFunctionResolver> tFnCls,
                                 FunctionInfo.FunctionResource... resources)

registerMacro

public FunctionInfo registerMacro(String macroName,
                         ExprNodeDesc body,
                         List<String> colNames,
                         List<TypeInfo> colTypes)

registerMacro

public FunctionInfo registerMacro(String macroName,
                         ExprNodeDesc body,
                         List<String> colNames,
                         List<TypeInfo> colTypes,
                         FunctionInfo.FunctionResource... resources)

registerPermanentFunction

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

getFunctionInfo

public FunctionInfo getFunctionInfo(String functionName)
                             throws SemanticException

Looks up the function name in the registry. If enabled, will attempt to search the metastore for the function.

Parameters:

functionName -

Returns:

Throws:

SemanticException

getWindowFunctionInfo

public WindowFunctionInfo getWindowFunctionInfo(String functionName)
                                         throws SemanticException

Throws:

SemanticException

isBuiltInFunc

public boolean isBuiltInFunc(Class<?> udfClass)

Parameters:

udfClass - Function class.

Returns:

True iff the fnExpr represents a hive built-in function.

getCurrentFunctionNames

public Set<String> getCurrentFunctionNames()

getFunctionNames

public Set<String> getFunctionNames(String funcPatternStr)

getFunctionNames

public Set<String> getFunctionNames(Pattern funcPattern)

Returns a set of registered function names. This is used for the CLI command "SHOW FUNCTIONS 'regular expression';" Returns an empty set when the regular expression is not valid.

Parameters:

funcPattern - regular expression of the interested function names

Returns:

set of strings contains function names

getFunctionSynonyms

public void getFunctionSynonyms(String funcName,
                       FunctionInfo funcInfo,
                       Set<String> synonyms)
                         throws SemanticException

Adds to the set of synonyms of the supplied function.

Parameters:

funcName -

funcInfo -

synonyms -

Throws:

SemanticException

getGenericUDAFEvaluator

public 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 GenericUDAFEvaluator getGenericWindowingEvaluator(String functionName,
                                                List<ObjectInspector> argumentOIs,
                                                boolean isDistinct,
                                                boolean isAllColumns)
                                                  throws SemanticException

Throws:

SemanticException

unregisterFunction

public void unregisterFunction(String functionName)
                        throws HiveException

Throws:

HiveException

getGenericUDAFResolver

public GenericUDAFResolver getGenericUDAFResolver(String functionName)
                                           throws SemanticException

Throws:

SemanticException

clear

public void clear()

closeCUDFLoaders

public void closeCUDFLoaders()

addToUDFLoaders

public void addToUDFLoaders(ClassLoader loader)

removeFromUDFLoaders

public void removeFromUDFLoaders(ClassLoader loader)

setupPermissionsForUDFs

public void setupPermissionsForUDFs(String whiteListStr,
                           String blackListStr)

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

Parameters:

whiteListStr -

blackListStr -