A set of parameters for GPUdb::showEnvironment. More…
#include <gpudb/protocol/show_environment.h>
Public Member Functions | |
| ShowEnvironmentRequest () | |
| Constructs a ShowEnvironmentRequest object with default parameters. | |
| ShowEnvironmentRequest (const std::string &environmentName_, const std::map< std::string, std::string > &options_) | |
| Constructs a ShowEnvironmentRequest object with the specified parameters. | |
Public Attributes | |
| std::string | environmentName |
| Name of the environment on which to retrieve information. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::showEnvironment.
Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.
Definition at line 21 of file show_environment.h.
Constructor & Destructor Documentation
◆ ShowEnvironmentRequest() [1/2]
| inline |
Constructs a ShowEnvironmentRequest object with default parameters.
Definition at line 26 of file show_environment.h.
◆ ShowEnvironmentRequest() [2/2]
| inline |
Constructs a ShowEnvironmentRequest object with the specified parameters.
| [in] | environmentName_ | Name 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 ”. |
| [in] | options_ | Optional parameters.
|
Definition at line 90 of file show_environment.h.
Member Data Documentation
◆ environmentName
| std::string gpudb::ShowEnvironmentRequest::environmentName |
Name 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 ”.
Definition at line 102 of file show_environment.h.
◆ options
| std::map<std::string, std::string> gpudb::ShowEnvironmentRequest::options |
Optional parameters.
- show_environment_no_error_if_not_exists: If true and if the environment specified in environmentName does not exist, no error is returned. If false and if the environment specified in environmentName does not exist, then an error is returned. Supported values:The default value is show_environment_false.
- show_environment_show_names_only: If true only return the names of the installed environments and omit package listing. Supported values:The default value is show_environment_false.
The default value is an empty map.
Definition at line 139 of file show_environment.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/show_environment.h