gpudb::GetRecordsByColumnResponse Struct Reference

A set of output parameters for 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
std::map< std::string, std::string >	info
gpudb_type_ptr_t	dataTypePtr

Detailed Description

A set of output parameters for 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 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.

If tableName is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (NOW()), identity (USER()), or constant-based functions (GEODIST(-77.11, 38.88, -71.06, 42.36)).

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

Definition at line 488 of file get_records_by_column.h.

Constructor & Destructor Documentation

gpudb::GetRecordsByColumnResponse::GetRecordsByColumnResponse ( )

inline

Constructs a GetRecordsByColumnResponse object with default parameter values.

Definition at line 495 of file get_records_by_column.h.

Member Data Documentation

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

Definition at line 508 of file get_records_by_column.h.

gpudb_type_ptr_t gpudb::GetRecordsByColumnResponse::dataTypePtr

Definition at line 512 of file get_records_by_column.h.

bool gpudb::GetRecordsByColumnResponse::hasMoreRecords

Definition at line 510 of file get_records_by_column.h.

std::map<std::string, std::string> gpudb::GetRecordsByColumnResponse::info

Definition at line 511 of file get_records_by_column.h.

std::string gpudb::GetRecordsByColumnResponse::responseSchemaStr

Definition at line 507 of file get_records_by_column.h.

std::string gpudb::GetRecordsByColumnResponse::tableName

Definition at line 506 of file get_records_by_column.h.

int64_t gpudb::GetRecordsByColumnResponse::totalNumberOfRecords

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