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. | |
| 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. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
| ShowStatisticsRequest (const std::vector< std::string > &tableNames_, const std::map< std::string, std::string > &options_) | |
| Constructs a ShowStatisticsRequest object with the specified parameters. | |
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]
| inline |
Constructs a ShowStatisticsRequest object with default parameters.
Definition at line 23 of file show_statistics.h.
◆ ShowStatisticsRequest() [2/2]
| inline |
Constructs a ShowStatisticsRequest object with the specified 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. A single entry of ’*’ expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry. |
| [in] | options_ | Optional parameters.
|
Definition at line 109 of file show_statistics.h.
Member Data Documentation
◆ options
| std::map<std::string, std::string> gpudb::ShowStatisticsRequest::options |
Optional parameters.
- show_statistics_no_error_if_not_exists: If true and if the table names specified in tableNames does not exist, no error is returned. If false and if the table names specified in tableNames does not exist, then an error is returned. Supported values:The default value is show_statistics_false.
- show_statistics_column_names: Columns, per table in tableNames, to collect statistics for wheninput.key options.collect_now is true; ignored otherwise. Encoded as a ’;‘-separated parallel array aligned with tableNames (e.g. ‘x,y;z’ requests columns x,y for the first table and z for the second). A value of '' expands to every collectable column on each table (geometry, vector, JSON, and array columns are skipped). An explicit list may not be combined with a '' table_names wildcard. The default value is ”.
- show_statistics_collect_now: If true, the columns named by input.key options.column_names are collected synchronously during this request and reflected in the response. Supported values:The default value is show_statistics_false.
The default value is an empty map.
Definition at line 174 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. A single entry of ’*’ expands to every user table the caller may read (excluding system schemas, views, and temporary tables); when used it must be the only entry.
Definition at line 124 of file show_statistics.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/show_statistics.h