gpudb::RawAggregateGroupByResponse Struct Reference

A set of output parameters for aggregateGroupByRaw(const AggregateGroupByRequest&) const. More...

#include <gpudb/protocol/aggregate_group_by.h>

Public Member Functions
	RawAggregateGroupByResponse ()
	Constructs a RawAggregateGroupByResponse object with default parameter values. More...

Public Attributes
std::string	responseSchemaStr
std::vector< uint8_t >	binaryEncodedResponse
std::string	jsonEncodedResponse
int64_t	totalNumberOfRecords
bool	hasMoreRecords

Detailed Description

A set of output parameters for aggregateGroupByRaw(const AggregateGroupByRequest&) const.

Calculates unique combinations (groups) of values for the given columns in a given table/view/collection and computes aggregates on each unique combination. This is somewhat analogous to an SQL-style SELECT...GROUP BY. Any column(s) can be grouped on, but only non-string (i.e. numeric) columns may be used for computing aggregates. The results can be paged via the offset and limit parameters. For example, to get 10 groups with the largest counts the inputs would be: limit=10, options={"sort_order":"descending", "sort_by":"value"}. options can be used to customize behavior of this call e.g. filtering or sorting the results. To group by 'x' and 'y' and compute the number of objects within each group, use column_names=['x','y','count(*)']. To also compute the sum of 'z' over each group, use column_names=['x','y','count(*)','sum(z)']. Available aggregation functions are: 'count(*)', 'sum', 'min', 'max', 'avg', 'mean', 'stddev', 'stddev_pop', 'stddev_samp', 'var', 'var_pop', 'var_samp', 'arg_min', 'arg_max' and 'count_distinct'. The response is returned as a dynamic schema. For details see: dynamic schemas documentation. If the 'result_table' option is provided then the results are stored in a table with the name given in the option and the results are not returned in the response.

Definition at line 264 of file aggregate_group_by.h.

Constructor & Destructor Documentation

gpudb::RawAggregateGroupByResponse::RawAggregateGroupByResponse ( )

inline

Constructs a RawAggregateGroupByResponse object with default parameter values.

Definition at line 271 of file aggregate_group_by.h.

Member Data Documentation

std::vector<uint8_t> gpudb::RawAggregateGroupByResponse::binaryEncodedResponse

Definition at line 281 of file aggregate_group_by.h.

bool gpudb::RawAggregateGroupByResponse::hasMoreRecords

Definition at line 284 of file aggregate_group_by.h.

std::string gpudb::RawAggregateGroupByResponse::jsonEncodedResponse

Definition at line 282 of file aggregate_group_by.h.

std::string gpudb::RawAggregateGroupByResponse::responseSchemaStr

Definition at line 280 of file aggregate_group_by.h.

int64_t gpudb::RawAggregateGroupByResponse::totalNumberOfRecords

Definition at line 283 of file aggregate_group_by.h.

---

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

• gpudb/protocol/aggregate_group_by.h