GPUdb C++ API  Version 7.2.2.4
gpudb::DropEnvironmentRequest Struct Reference

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. More...
 
 DropEnvironmentRequest (const std::string &environmentName_, const std::map< std::string, std::string > &options_)
 Constructs a DropEnvironmentRequest object with the specified parameters. More...
 

Public Attributes

std::string environmentName
 Name of the environment to be dropped. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

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]

gpudb::DropEnvironmentRequest::DropEnvironmentRequest ( )
inline

Constructs a DropEnvironmentRequest object with default parameters.

Definition at line 24 of file drop_environment.h.

◆ DropEnvironmentRequest() [2/2]

gpudb::DropEnvironmentRequest::DropEnvironmentRequest ( const std::string &  environmentName_,
const std::map< std::string, std::string > &  options_ 
)
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. The default value is an empty map.

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.

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: