Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

Show Environment

Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.

Input Parameter Description

NameTypeDescription
environment_namestringName of the environment on which to retrieve information. The name must refer to a currently existing environment. If '*' or an empty value is specified, information about all environments will be returned. The default value is ''.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
no_error_if_not_exists

If true and if the environment specified in input parameter environment_name does not exist, no error is returned. If false and if the environment specified in input parameter environment_name does not exist, then an error is returned. The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

NameTypeDescription
environment_namesarray of stringsA list of all credential names.
packagesarray of arrays of stringsInformation about the installed packages in the respective environments in output parameter environment_names.
infomap of string to stringsAdditional information.