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 a response will not be returned 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. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Definition at line 27 of file filter_by_value.h.

Constructor & Destructor Documentation

◆ FilterByValueRequest() [1/2]

gpudb::FilterByValueRequest::FilterByValueRequest ( )

inline

Constructs a FilterByValueRequest object with default parameter values.

Definition at line 34 of file filter_by_value.h.

◆ FilterByValueRequest() [2/2]

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 table on which to perform the calculation.
[in]	viewName_	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
[in]	isString_	Indicates whether the value being searched for is string or numeric.
[in]	value_	The value to search for.
[in]	valueStr_	The string value to search for.
[in]	columnName_	Name of a column on which the filter by value would be applied.
[in]	options_	Optional parameters. gpudb::filter_by_value_collection_name: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.

Definition at line 74 of file filter_by_value.h.

Member Data Documentation

◆ columnName

std::string gpudb::FilterByValueRequest::columnName

Definition at line 90 of file filter_by_value.h.

◆ isString

bool gpudb::FilterByValueRequest::isString

Definition at line 87 of file filter_by_value.h.

◆ options

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

Definition at line 91 of file filter_by_value.h.

◆ tableName

std::string gpudb::FilterByValueRequest::tableName

Definition at line 85 of file filter_by_value.h.

◆ value

double gpudb::FilterByValueRequest::value

Definition at line 88 of file filter_by_value.h.

◆ valueStr

std::string gpudb::FilterByValueRequest::valueStr

Definition at line 89 of file filter_by_value.h.

◆ viewName

std::string gpudb::FilterByValueRequest::viewName

Definition at line 86 of file filter_by_value.h.

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

gpudb/protocol/filter_by_value.h

Public Member Functions

Public Attributes