[ 
https://issues.apache.org/jira/browse/HIVE-691?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12737269#action_12737269
 ] 

Emil Ibrishimov commented on HIVE-691:
--------------------------------------

So far, I added "DESCRIBE FUNCTION" and "DESCRIBE FUNCTION EXTENDED":

  query: DESCRIBE FUNCTION conv
  conv - Convert numbers between different bases
  query: DESCRIBE FUNCTION EXTENDED conv
  conv - Convert numbers between different bases
    conv(num, from_base, to_base) - convert num from from_base to to_base; if 
to_base is negative, treat num as a signed integer,otherwise, treat it as an 
unsigned integer.

There are two types of description - short and extended - for each udf. They 
are added as annotations. Is that what we are looking for? I can also add 
"DESCRIBE FUNCTIONS <regexp>" that show the short descriptions of all functions 
that match <regexp> if you think it is a good idea?


> show documentation for user defined functions
> ---------------------------------------------
>
>                 Key: HIVE-691
>                 URL: https://issues.apache.org/jira/browse/HIVE-691
>             Project: Hadoop Hive
>          Issue Type: Improvement
>          Components: Query Processor
>            Reporter: Prasad Chakka
>            Assignee: Emil Ibrishimov
>
> There are lot of functions and more of them will be added. I think it is 
> cumbersome to update wiki or ask users to go to wiki to find out 
> documentation. instead each user defined function can have an annotation 
> containing documentation and 'show functions' command or similar can show the 
> documentation to users on command line. it will also be easier to update the 
> documentation along with code.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to