GPUdb C++ API  Version 7.2.2.4
gpudb::ShowStatisticsRequest Struct Reference

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

#include <gpudb/protocol/show_statistics.h>

Public Member Functions

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

Public Attributes

std::vector< std::string > tableNames
 Names of tables whose metadata will be fetched, each in [ schema_name. ]table_name format, using standard name resolution rules. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showStatistics.

Retrieves the collected column statistics for the specified table(s).

Definition at line 18 of file show_statistics.h.

Constructor & Destructor Documentation

◆ ShowStatisticsRequest() [1/2]

gpudb::ShowStatisticsRequest::ShowStatisticsRequest ( )
inline

Constructs a ShowStatisticsRequest object with default parameters.

Definition at line 23 of file show_statistics.h.

◆ ShowStatisticsRequest() [2/2]

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

Constructs a ShowStatisticsRequest object with the specified parameters.

Parameters
[in]tableNames_Names of tables whose metadata will be fetched, each 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 68 of file show_statistics.h.

Member Data Documentation

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 105 of file show_statistics.h.

◆ tableNames

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

Names of tables whose metadata will be fetched, each in [ schema_name. ]table_name format, using standard name resolution rules.

All provided tables must exist, or an error is returned.

Definition at line 81 of file show_statistics.h.


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