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. | |
| 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. | |
Public Attributes | |
| std::string | tableName |
| Name of a table, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| std::vector< std::string > | columnNames |
| List of one or more column names in tableName for which to collect statistics (cardinality, mean value, etc.). | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
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]
| inline |
Constructs a CollectStatisticsRequest object with default parameters.
Definition at line 24 of file collect_statistics.h.
◆ CollectStatisticsRequest() [2/2]
| inline |
Constructs a CollectStatisticsRequest object with the specified parameters.
| [in] | tableName_ | Name of a table, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. A value of ’*’ collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, columnNames_ must be ’*’. |
| [in] | columnNames_ | List of one or more column names in tableName_ for which to collect statistics (cardinality, mean value, etc.). A single entry of ’*’ expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped). |
| [in] | options_ | Optional parameters. The default value is an empty map. |
Definition at line 53 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.).
A single entry of ’*’ expands to every collectable column on the table (geometry, vector, JSON, and array columns are skipped).
Definition at line 76 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 81 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. A value of ’*’ collects statistics on every user table the caller may read (excluding system schemas, views, and temporary tables); when used, columnNames must be ’*’.
Definition at line 68 of file collect_statistics.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/collect_statistics.h