Example of HelpInfo Annotation Using the API - Aster Execution Engine

Teradata Aster® Developer Guide

Product
Aster Execution Engine
Release Number
7.00.02
Published
July 2017
Language
English (United States)
Last Update
2018-04-13
dita:mapPath
xnl1494366523182.ditamap
dita:ditavalPath
Generic_no_ie_no_tempfilter.ditaval
dita:id
ffu1489104705746
lifecycle
previous
Product Category
Software
@HelpInfo(
   usageSyntax
      = "runinisolatedjvm("
      + " on empty_partitioned_table partition by <key>"
      + " load_function_file_twice('yes'|'<any other values means no>'[default])"
      + " )",
   shortDescription = "",
   longDescription = "Outputs pid of process it runs in and adds function file"
                   + " RunInIsolatedJVM.jar to loader path once or twice as"
                   + " dictated by arguemnts."
                   + " Using load_function_file_twice('yes') will be a"
                   + " negative test and result in an error",
   inputColumns = "*",
   outputColumns = "*",
   author = "Function Author",
   version = "My Function 1.0000",
   apiVersion = ApiVersion.CURRENT_API_VERSION,
/***** The following will make each instance of the function on a single physical node Run in an Isolated JVM as opposed to a shared JVM *******/
            executionMode = ExecutionMode.IsolatedProcess
)