GPUdb C++ API  Version 7.2.3.0
gpudb::DropCatalogRequest Struct Reference

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

#include <gpudb/protocol/drop_catalog.h>

Public Member Functions

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

Public Attributes

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

Detailed Description

A set of parameters for GPUdb::dropCatalog.

Drops an existing catalog. Any external tables that depend on the catalog must be dropped before it can be dropped.

Definition at line 19 of file drop_catalog.h.

Constructor & Destructor Documentation

◆ DropCatalogRequest() [1/2]

gpudb::DropCatalogRequest::DropCatalogRequest ( )
inline

Constructs a DropCatalogRequest object with default parameters.

Definition at line 24 of file drop_catalog.h.

◆ DropCatalogRequest() [2/2]

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

Constructs a DropCatalogRequest object with the specified parameters.

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

Definition at line 39 of file drop_catalog.h.

Member Data Documentation

◆ name

std::string gpudb::DropCatalogRequest::name

Name of the catalog to be dropped.

Must be an existing catalog.

Definition at line 48 of file drop_catalog.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 53 of file drop_catalog.h.


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