tajo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hyunsik Choi (JIRA)" <j...@apache.org>
Subject [jira] [Created] (TAJO-409) Add explored and explained annotations to Tajo function system
Date Wed, 11 Dec 2013 05:47:08 GMT
Hyunsik Choi created TAJO-409:
---------------------------------

             Summary: Add explored and explained annotations to Tajo function system
                 Key: TAJO-409
                 URL: https://issues.apache.org/jira/browse/TAJO-409
             Project: Tajo
          Issue Type: Sub-task
          Components: function/udf
            Reporter: Hyunsik Choi
             Fix For: 0.8-incubating


Currently, it is hard for developers to add explanations to functions and user-defined functions.
Java has annotation feature. We can make function system more explored and explained with
java annotations.

h3. Proposal

A function should have the following annotations
 * function name (string) - optional
   ** If a function is user-defined, this field is ignored.
   ** the function name of user-defined function is given when it is registered.
 * synonyms (string []) - optional
   ** If a function is user-defined, this field is ignored.
   ** One or more aliases can be described.
 * description (string)
   ** *one* line explanation for a function
 * detail (string) - optional
   ** more explanations which can be two or more lines
 * example
   ** what are parameters and what is a result.

Function signatures can be derived from function name, parameters, and return types.



--
This message was sent by Atlassian JIRA
(v6.1.4#6159)

Mime
View raw message