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

#include <gpudb/protocol/get_records_by_column.h>

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

Public Attributes
std::string	tableName

std::string	responseSchemaStr

std::vector< gpudb::GenericRecord >	data

int64_t	totalNumberOfRecords

bool	hasMoreRecords

gpudb_type_ptr_t	dataTypePtr

Detailed Description

A set of output parameters for getRecordsByColumn(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 423 of file get_records_by_column.h.

Constructor & Destructor Documentation

◆ GetRecordsByColumnResponse()

gpudb::GetRecordsByColumnResponse::GetRecordsByColumnResponse ( )

inline

Constructs a GetRecordsByColumnResponse object with default parameter values.

Definition at line 430 of file get_records_by_column.h.

Member Data Documentation

◆ data

std::vector<gpudb::GenericRecord> gpudb::GetRecordsByColumnResponse::data

Definition at line 442 of file get_records_by_column.h.

◆ dataTypePtr

gpudb_type_ptr_t gpudb::GetRecordsByColumnResponse::dataTypePtr

Definition at line 445 of file get_records_by_column.h.

◆ hasMoreRecords

bool gpudb::GetRecordsByColumnResponse::hasMoreRecords

Definition at line 444 of file get_records_by_column.h.

◆ responseSchemaStr

std::string gpudb::GetRecordsByColumnResponse::responseSchemaStr

Definition at line 441 of file get_records_by_column.h.

◆ tableName

std::string gpudb::GetRecordsByColumnResponse::tableName

Definition at line 440 of file get_records_by_column.h.

◆ totalNumberOfRecords

int64_t gpudb::GetRecordsByColumnResponse::totalNumberOfRecords

Definition at line 443 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