A set of parameters for GPUdb::dropEnvironment. More…
#include <gpudb/protocol/drop_environment.h>
Public Member Functions | |
| DropEnvironmentRequest () | |
| Constructs a DropEnvironmentRequest object with default parameters. | |
| DropEnvironmentRequest (const std::string &environmentName_, const std::map< std::string, std::string > &options_) | |
| Constructs a DropEnvironmentRequest object with the specified parameters. | |
Public Attributes | |
| std::string | environmentName |
| Name of the environment to be dropped. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::dropEnvironment.
Drop an existing user-defined function (UDF) environment.
Definition at line 19 of file drop_environment.h.
Constructor & Destructor Documentation
◆ DropEnvironmentRequest() [1/2]
| inline |
Constructs a DropEnvironmentRequest object with default parameters.
Definition at line 24 of file drop_environment.h.
◆ DropEnvironmentRequest() [2/2]
| inline |
Constructs a DropEnvironmentRequest object with the specified parameters.
Parameters
| [in] | environmentName_ | Name of the environment to be dropped. Must be an existing environment. |
| [in] | options_ | Optional parameters.
|
Definition at line 64 of file drop_environment.h.
Member Data Documentation
◆ environmentName
| std::string gpudb::DropEnvironmentRequest::environmentName |
Name of the environment to be dropped.
Must be an existing environment.
Definition at line 74 of file drop_environment.h.
◆ options
| std::map<std::string, std::string> gpudb::DropEnvironmentRequest::options |
Optional parameters.
- drop_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 drop_environment_false.
The default value is an empty map.
Definition at line 98 of file drop_environment.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/drop_environment.h