GPUdb C++ API  Version 6.2.0.3
gpudb::ShowTypesRequest Struct Reference

A set of input parameters for showTypes(const ShowTypesRequest&) const. More...

#include <gpudb/protocol/show_types.h>

Public Member Functions

 ShowTypesRequest ()
 Constructs a ShowTypesRequest object with default parameter values. More...
 
 ShowTypesRequest (const std::string &typeId_, const std::string &label_, const std::map< std::string, std::string > &options_)
 Constructs a ShowTypesRequest object with the specified parameters. More...
 

Public Attributes

std::string typeId
 
std::string label
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for showTypes(const ShowTypesRequest&) const.

Retrieves information for the specified data type ID or type label. For all data types that match the input criteria, the database returns the type ID, the type schema, the label (if available), and the type's column properties.

Definition at line 21 of file show_types.h.

Constructor & Destructor Documentation

◆ ShowTypesRequest() [1/2]

gpudb::ShowTypesRequest::ShowTypesRequest ( )
inline

Constructs a ShowTypesRequest object with default parameter values.

Definition at line 27 of file show_types.h.

◆ ShowTypesRequest() [2/2]

gpudb::ShowTypesRequest::ShowTypesRequest ( const std::string &  typeId_,
const std::string &  label_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowTypesRequest object with the specified parameters.

Parameters
[in]typeId_Type Id returned in response to a call to /create/type.
[in]label_Option string that was supplied by user in a call to /create/type.
[in]options_Optional parameters.

Definition at line 54 of file show_types.h.

Member Data Documentation

◆ label

std::string gpudb::ShowTypesRequest::label

Definition at line 62 of file show_types.h.

◆ options

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

Definition at line 63 of file show_types.h.

◆ typeId

std::string gpudb::ShowTypesRequest::typeId

Definition at line 61 of file show_types.h.


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