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

A set of input parameters for showTablesByType(const ShowTablesByTypeRequest&) const. More...

#include <gpudb/protocol/show_tables_by_type.h>

Public Member Functions

 ShowTablesByTypeRequest ()
 Constructs a ShowTablesByTypeRequest object with default parameter values. More...
 
 ShowTablesByTypeRequest (const std::string &typeId_, const std::string &label_, const std::map< std::string, std::string > &options_)
 Constructs a ShowTablesByTypeRequest 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 showTablesByType(const ShowTablesByTypeRequest&) const.

Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Definition at line 22 of file show_tables_by_type.h.

Constructor & Destructor Documentation

◆ ShowTablesByTypeRequest() [1/2]

gpudb::ShowTablesByTypeRequest::ShowTablesByTypeRequest ( )
inline

Constructs a ShowTablesByTypeRequest object with default parameter values.

Definition at line 29 of file show_tables_by_type.h.

◆ ShowTablesByTypeRequest() [2/2]

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

Constructs a ShowTablesByTypeRequest object with the specified parameters.

Parameters
[in]typeId_Type id returned by a call to /create/type.
[in]label_Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
[in]options_Optional parameters.

Definition at line 47 of file show_tables_by_type.h.

Member Data Documentation

◆ label

std::string gpudb::ShowTablesByTypeRequest::label

Definition at line 55 of file show_tables_by_type.h.

◆ options

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

Definition at line 56 of file show_tables_by_type.h.

◆ typeId

std::string gpudb::ShowTablesByTypeRequest::typeId

Definition at line 54 of file show_tables_by_type.h.


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