A set of output parameters for getRecordsByColumnRaw(const GetRecordsByColumnRequest&) const. More...

#include <gpudb/protocol/get_records_by_column.h>

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

Public Attributes
std::string	tableName

std::string	responseSchemaStr

std::vector< uint8_t >	binaryEncodedResponse

std::string	jsonEncodedResponse

int64_t	totalNumberOfRecords

bool	hasMoreRecords

Detailed Description

A set of output parameters for getRecordsByColumnRaw(const GetRecordsByColumnRequest&) const.

For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the offset and limit parameters.

Window functions, which can perform operations like moving averages, are available through this endpoint as well as createProjection(const CreateProjectionRequest&) const.

When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.

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

Definition at line 304 of file get_records_by_column.h.

Constructor & Destructor Documentation

◆ RawGetRecordsByColumnResponse()

gpudb::RawGetRecordsByColumnResponse::RawGetRecordsByColumnResponse ( )

inline

Constructs a RawGetRecordsByColumnResponse object with default parameter values.

Definition at line 311 of file get_records_by_column.h.

Member Data Documentation

◆ binaryEncodedResponse

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

Definition at line 323 of file get_records_by_column.h.

◆ hasMoreRecords

bool gpudb::RawGetRecordsByColumnResponse::hasMoreRecords

Definition at line 326 of file get_records_by_column.h.

◆ jsonEncodedResponse

std::string gpudb::RawGetRecordsByColumnResponse::jsonEncodedResponse

Definition at line 324 of file get_records_by_column.h.

◆ responseSchemaStr

std::string gpudb::RawGetRecordsByColumnResponse::responseSchemaStr

Definition at line 322 of file get_records_by_column.h.

◆ tableName

std::string gpudb::RawGetRecordsByColumnResponse::tableName

Definition at line 321 of file get_records_by_column.h.

◆ totalNumberOfRecords

int64_t gpudb::RawGetRecordsByColumnResponse::totalNumberOfRecords

Definition at line 325 of file get_records_by_column.h.

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

gpudb/protocol/get_records_by_column.h

Public Member Functions

Public Attributes