GPUdb C++ API  Version 6.2.0.3
gpudb::RawAggregateUniqueResponse Struct Reference

A set of output parameters for aggregateUniqueRaw(const AggregateUniqueRequest&) const. More...

#include <gpudb/protocol/aggregate_unique.h>

Public Member Functions

 RawAggregateUniqueResponse ()
 Constructs a RawAggregateUniqueResponse object with default parameter values. More...
 

Public Attributes

std::string tableName
 
std::string responseSchemaStr
 
std::vector< uint8_t > binaryEncodedResponse
 
std::string jsonEncodedResponse
 
bool hasMoreRecords
 

Detailed Description

A set of output parameters for aggregateUniqueRaw(const AggregateUniqueRequest&) const.

Returns all the unique values from a particular column (specified by columnName) of a particular table or collection (specified by tableName). If columnName is a numeric column the values will be in binaryEncodedResponse. Otherwise if columnName is a string column the values will be in jsonEncodedResponse. The results can be paged via the offset and limit parameters.

Columns marked as store-only are unable to be used with this function.

To get the first 10 unique values sorted in descending order options would be::

{"limit":"10","sort_order":"descending"}.

The response is returned as a dynamic schema. For details see: dynamic schemas documentation.

If a result_table name is specified in the options, the results are stored in a new table with that name–no results are returned in the response. Both the table name and resulting column name must adhere to standard naming conventions; any column expression will need to be aliased. If the source table's shard key is used as the columnName, the result table will be sharded, in all other cases it will be replicated. Sorting will properly function only if the result table is replicated or if there is only one processing node and should not be relied upon in other cases. Not available if tableName is a collection or when the value of columnName is an unrestricted-length string.

Definition at line 416 of file aggregate_unique.h.

Constructor & Destructor Documentation

◆ RawAggregateUniqueResponse()

gpudb::RawAggregateUniqueResponse::RawAggregateUniqueResponse ( )
inline

Constructs a RawAggregateUniqueResponse object with default parameter values.

Definition at line 423 of file aggregate_unique.h.

Member Data Documentation

◆ binaryEncodedResponse

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

Definition at line 434 of file aggregate_unique.h.

◆ hasMoreRecords

bool gpudb::RawAggregateUniqueResponse::hasMoreRecords

Definition at line 436 of file aggregate_unique.h.

◆ jsonEncodedResponse

std::string gpudb::RawAggregateUniqueResponse::jsonEncodedResponse

Definition at line 435 of file aggregate_unique.h.

◆ responseSchemaStr

std::string gpudb::RawAggregateUniqueResponse::responseSchemaStr

Definition at line 433 of file aggregate_unique.h.

◆ tableName

std::string gpudb::RawAggregateUniqueResponse::tableName

Definition at line 432 of file aggregate_unique.h.


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