gpudb::FilterByValueRequest Struct Reference

A set of input parameters for filterByValue(const FilterByValueRequest&) const. More...

#include <gpudb/protocol/filter_by_value.h>

Public Member Functions
	FilterByValueRequest ()
	Constructs a FilterByValueRequest object with default parameter values. More...
	FilterByValueRequest (const std::string &tableName, const std::string &viewName, const bool isString, const double value, const std::string &valueStr, const std::string &columnName, const std::map< std::string, std::string > &options)
	Constructs a FilterByValueRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	viewName
bool	isString
double	value
std::string	valueStr
std::string	columnName
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for filterByValue(const FilterByValueRequest&) const.

Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous meaning that GPUdb will not return a response until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload.

Definition at line 26 of file filter_by_value.h.

Constructor & Destructor Documentation

gpudb::FilterByValueRequest::FilterByValueRequest ( )

inline

Constructs a FilterByValueRequest object with default parameter values.

Definition at line 33 of file filter_by_value.h.

gpudb::FilterByValueRequest::FilterByValueRequest ( const std::string &  tableName, const std::string &  viewName, const bool  isString, const double  value, const std::string &  valueStr, const std::string &  columnName, const std::map< std::string, std::string > &  options  )

inline

Constructs a FilterByValueRequest object with the specified parameters.

Parameters

[in]	tableName	Name of an existing GPUdb table on which to perform the calculation.
[in]	viewName	If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view. Default value is an empty string.
[in]	isString	Indicates whether the value being searched for is string or numeric.
[in]	value	The value to search for. Default value is 0.
[in]	valueStr	The string value to search for. Default value is an empty string.
[in]	columnName	Name of a column or an expression of one or more columns on which the filter by value would be applied.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 66 of file filter_by_value.h.

Member Data Documentation

std::string gpudb::FilterByValueRequest::columnName

Definition at line 82 of file filter_by_value.h.

bool gpudb::FilterByValueRequest::isString

Definition at line 79 of file filter_by_value.h.

std::map<std::string, std::string> gpudb::FilterByValueRequest::options

Definition at line 83 of file filter_by_value.h.

std::string gpudb::FilterByValueRequest::tableName

Definition at line 77 of file filter_by_value.h.

double gpudb::FilterByValueRequest::value

Definition at line 80 of file filter_by_value.h.

std::string gpudb::FilterByValueRequest::valueStr

Definition at line 81 of file filter_by_value.h.

std::string gpudb::FilterByValueRequest::viewName

Definition at line 78 of file filter_by_value.h.

---

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

• gpudb/protocol/filter_by_value.h