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

A set of input parameters for showTableMetadata(const ShowTableMetadataRequest&) const. More...

#include <gpudb/protocol/show_table_metadata.h>

Public Member Functions

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

Public Attributes

std::vector< std::string > tableNames
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for showTableMetadata(const ShowTableMetadataRequest&) const.

Retrieves the user provided metadata for the specified tables.

Definition at line 18 of file show_table_metadata.h.

Constructor & Destructor Documentation

◆ ShowTableMetadataRequest() [1/2]

gpudb::ShowTableMetadataRequest::ShowTableMetadataRequest ( )
inline

Constructs a ShowTableMetadataRequest object with default parameter values.

Definition at line 25 of file show_table_metadata.h.

◆ ShowTableMetadataRequest() [2/2]

gpudb::ShowTableMetadataRequest::ShowTableMetadataRequest ( const std::vector< std::string > &  tableNames_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowTableMetadataRequest object with the specified parameters.

Parameters
[in]tableNames_Tables whose metadata will be fetched. All provided tables must exist, or an error is returned.
[in]options_Optional parameters.

Definition at line 41 of file show_table_metadata.h.

Member Data Documentation

◆ options

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

Definition at line 48 of file show_table_metadata.h.

◆ tableNames

std::vector<std::string> gpudb::ShowTableMetadataRequest::tableNames

Definition at line 47 of file show_table_metadata.h.


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