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

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

#include <gpudb/protocol/collect_statistics.h>

Public Member Functions

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

Public Attributes

std::string tableName
 Name of a table, in [ schema_name. ]table_name format, using standard name resolution rules. More...
 
std::vector< std::string > columnNames
 List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::collectStatistics.

Collect statistics for a column(s) in a specified table.

Definition at line 18 of file collect_statistics.h.

Constructor & Destructor Documentation

◆ CollectStatisticsRequest() [1/2]

gpudb::CollectStatisticsRequest::CollectStatisticsRequest ( )
inline

Constructs a CollectStatisticsRequest object with default parameters.

Definition at line 24 of file collect_statistics.h.

◆ CollectStatisticsRequest() [2/2]

gpudb::CollectStatisticsRequest::CollectStatisticsRequest ( const std::string &  tableName_,
const std::vector< std::string > &  columnNames_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a CollectStatisticsRequest object with the specified parameters.

Parameters
[in]tableName_Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
[in]columnNames_List of one or more column names in tableName_ for which to collect statistics (cardinality, mean value, etc.).
[in]options_Optional parameters. The default value is an empty map.

Definition at line 46 of file collect_statistics.h.

Member Data Documentation

◆ columnNames

std::vector<std::string> gpudb::CollectStatisticsRequest::columnNames

List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.).

Definition at line 64 of file collect_statistics.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 69 of file collect_statistics.h.

◆ tableName

std::string gpudb::CollectStatisticsRequest::tableName

Name of a table, in [ schema_name. ]table_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 58 of file collect_statistics.h.


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