[PHOENIX-538] Support UDFs

• Type: Task
• Status: Closed
• Resolution: Fixed
• Fix Version/s: 4.4.0
• old issue number: 407
• Assignee: Rajeshbabu Chintaguntla
• Reporter: James R. Taylor
• Created: 10/Mar/14 23:47
• Updated: 02/Jun/21 21:13
• Resolved: 21/Nov/15 01:14

Description

Phoenix allows built-in functions to be added (as described [here](http://phoenix-hbase.blogspot.com/2013/04/how-to-add-your-own-built-in-function.html)) with the restriction that they must be in the phoenix jar. We should improve on this and allow folks to declare new functions through a CREATE FUNCTION command like this:

CREATE FUNCTION mdHash(anytype)
RETURNS binary(16)
LOCATION 'hdfs://path-to-my-jar' 'com.me.MDHashFunction'

Since HBase supports loading jars dynamically, this would not be too difficult. The function implementation class would be required to extend our ScalarFunction base class. Here's how I could see it being implemented:

• modify the phoenix grammar to support the new CREATE FUNCTION syntax
• create a new UTFParseNode class to capture the parse state
• add a new method to the MetaDataProtocol interface
• add a new method in ConnectionQueryServices to invoke the MetaDataProtocol method
• add a new method in MetaDataClient to invoke the ConnectionQueryServices method
• persist functions in a new "SYSTEM.FUNCTION" table
• add a new client-side representation to cache functions called PFunction
• modify ColumnResolver to dynamically resolve a function in the same way we dynamically resolve and load a table
• create and register a new ExpressionType called UDFExpression
• at parse time, check for the function name in the built in list first (as is currently done), and if not found in the PFunction cache. If not found there, then use the new UDFExpression as a placeholder and have the ColumnResolver attempt to resolve it at compile time and throw an error if unsuccessful.

Issue Links

• relates to: PHOENIX-2011 Default, min, and max values should not require quotes around it in create function

Sub-Tasks

• Support alter/replace and drop functions: Closed
• Provide queries for adding/deleting jars to/from common place in hdfs which is used by dynamic class loader: Closed
• Update functional index data created with UDF when there is change in implementation.: Open
• Add support for DatabaseMetaData.getFunctionColumns() and getFunctions() calls.: Open
• Documentation for UDF support: Closed