Uploaded image for project: 'Tajo'
  1. Tajo
  2. TAJO-408 Improve function system
  3. TAJO-409

Add explored and explained annotations to Tajo function system

    Details

    • Type: Sub-task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.8.0
    • Component/s: Function/UDF
    • Labels:
      None

      Description

      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.

      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.

        Attachments

        1. TAJO-409.patch
          188 kB
          SeongHwa Ahn
        2. TAJO-409_20140119_22:11:45.patch
          188 kB
          Hyunsik Choi

          Issue Links

            Activity

              People

              • Assignee:
                epsilon SeongHwa Ahn
                Reporter:
                hyunsik Hyunsik Choi
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: