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

A set of parameters for GPUdb::dropDatasink. More...

#include <gpudb/protocol/drop_datasink.h>

Public Member Functions

 DropDatasinkRequest ()
 Constructs a DropDatasinkRequest object with default parameters. More...
 
 DropDatasinkRequest (const std::string &name_, const std::map< std::string, std::string > &options_)
 Constructs a DropDatasinkRequest object with the specified parameters. More...
 

Public Attributes

std::string name
 Name of the data sink to be dropped. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::dropDatasink.

Drops an existing data sink.

By default, if any table monitors use this sink as a destination, the request will be blocked unless option clear_table_monitors is true.

Definition at line 25 of file drop_datasink.h.

Constructor & Destructor Documentation

◆ DropDatasinkRequest() [1/2]

gpudb::DropDatasinkRequest::DropDatasinkRequest ( )
inline

Constructs a DropDatasinkRequest object with default parameters.

Definition at line 30 of file drop_datasink.h.

◆ DropDatasinkRequest() [2/2]

gpudb::DropDatasinkRequest::DropDatasinkRequest ( const std::string &  name_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a DropDatasinkRequest object with the specified parameters.

Parameters
[in]name_Name of the data sink to be dropped. Must be an existing data sink.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 65 of file drop_datasink.h.

Member Data Documentation

◆ name

std::string gpudb::DropDatasinkRequest::name

Name of the data sink to be dropped.

Must be an existing data sink.

Definition at line 74 of file drop_datasink.h.

◆ options

std::map<std::string, std::string> gpudb::DropDatasinkRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 95 of file drop_datasink.h.


The documentation for this struct was generated from the following file: