gpudb::ShowTableMetadataRequest Struct Reference

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

#include <gpudb/protocol/show_table_metadata.h>

Public Member Functions
	ShowTableMetadataRequest ()
	Constructs a ShowTableMetadataRequest object with default parameters. 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
	Names of tables whose metadata will be fetched, in [ schema_name. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::showTableMetadata.

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 parameters.

Definition at line 24 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_	Names of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 44 of file show_table_metadata.h.

Member Data Documentation

options

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

Optional parameters.

The default value is an empty map.

Definition at line 62 of file show_table_metadata.h.

tableNames

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

Names of tables whose metadata will be fetched, in [ schema_name.

\ ]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned.

Definition at line 57 of file show_table_metadata.h.

---

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

• gpudb/protocol/show_table_metadata.h