Complete list of register_ae options
This section provides a complete list of options for register_ae.
The following syntax is supported for using the
options::
$NZ_EXPORT_DIR/ae/utilities/bin/register_ae [OPTION]...
To list the options,
run:
$NZ_EXPORT_DIR/ae/utilities/bin/register_ae --helpThe following list shows supported options.
General options:
- --echo
- Echo substituted template before running it and the shell output.
- --file file
- Use specified template file instead of the installed template.
- --base base
- Base directory for NPS instead of environment NZ_KIT_DIR or
/nz/kit. Available as template variableae_kit. - --ldir base
- Base directory for language configurations instead of /nz/export/ae/adapters
- --language lang
- Specify language configuration to use. Languages are cpp, fortran, java, perl, python64,
python3x, r, system available as template variable
ae_language. - --version ver
- Specify language version to use. Available as template variable
ae_lang_ver. - --template name
- Specify the template to use. Common ones are udf, uda, udtf.
- --user username
- NPS username (defaults to environment: NZ_USER). Available as template variable
ae_user. - --pw password
- NPS password (defaults to environment: NZ_PASSWORD). Available as template variable
ae_password. - --db database
- NPS database (defaults to environment: NZ_DATABASE). Available as template variable
ae_db. - -h, --help
- Show this command usage.General template options include the following predefined template variables:
ae_export_dir- location of shared export directoryae_sysroot_spu- location of system root on SPUae_sysroot_host- location of system root on hostae_library_path_spu- LD_LIBRARY_PATH for SPUae_library_path_host- LD_LIBRARY_PATH for host
- --define var=value
- Define template variable.
- --path dir
- Location where AE files are stored. Defaults to
<ae_export_dir>/ae/applications/<ae_db>/<ae_user>. Available as
template variable
ae_application_path. - --warn
- Warn instead of error if
--pathdoes not start with <ae_export_dir>/ae/applications/<ae_db> - --environment val
- Environment entry
--environment "'name' = 'value'". Can be specified multiple times. Available as template variableae_environment_entries(a comma-separated list). - --deps libs
-
Library dependencies.
Libsmust be comma-separated. Available as template variableae_dependencies. - --level level
- Debug level for AE (default 0). Available as template variable
ae_debug_level. - --idir dir
- Install dir for the AE language. Available as template variable
ae_install_dir. - --udxtype type
- UDX type. Must be one of udf, udtf, or uda. Available as template
variable ae_type. - --sig signature
- Argument signature for function or aggregate. UDXname (arg1, arg2, ...) needs to be quoted to
stop the shell interpreting from the ()'s. Available as template variable
ae_sig. - --return return
- Return type for function or aggregate. For table function, needs to be quoted to stop the shell
from interpreting the ()'s. Available as template variable
ae_return. - --class class
- Class name for function or aggregate. Available as template variable
ae_class. - --mask args
- Can be DEBUG or TRACE. Can be specified multiple times. Available as template variable
ae_mask. - --mem num
- Memory must be a number and units. A size can be b (bytes), k (kilobytes), m (megabytes), g
(gigabytes) or can be empty. For example, 100, 1m, 100k. Available as template variable
ae_mem. - --remote
- AE remote mode enabled. Available as template variable
ae_remote. - --launch
- AE remote launch enabled. Available as template variable
ae_launch. - --dynamic num
- Set AE dynamic environment level. Default is 0. Available as template variable
ae_dynamic. - --rtrans
- AE remote name transaction enabled. Available as template variable
ae_remote_transaction. - --rsession
- AE remote name session enabled. Available as template variable
variable ae_remote_session. - --rdataslice
- AE remote name data slice enabled. Available as template variable
ae_remote_dataslice. - --rname name
- Set AE remote name to name. Available as template variable
ae_remote_name. - --exe name
- Set AE executable name to name. Available as template variable
ae_exe_name.
Scalar function template options:
- --nondet
- Non-deterministic. Default is deterministic. Available as template variable
ae_deterministic. - --nullcall
- CALLED ON NULL INPUT. Default is RETURNS NULL ON NULL INPUT. Available as template variable
ae_nullcall.
Table function template options:
- --noparallel
-
Table function is created with parallel not allowed. Default is parallel allowed. Available as template variable
ae_parallel. - --lastcall args
- Table function is created with args ALLOWED. Possible values are TABLE, TABLE
FINAL, or TABLE, TABLE FINAL. Default is TABLE, TABLE FINAL. Available as template variable
ae_lastcall.
Aggregate template options:
- --state state
- State signature for aggregate. (state1, state2, ...). Needs to be quoted to stop the shell from
interpreting the ()'s. Available as template variable
ae_state. - --aggtype aggtype
- Specify agg type. Can be ANY, ANALYTIC, or GROUPED. Available as template
variable
ae_uda_type.