gpudb::FilterByRangeRequest Struct Reference

A set of input parameters for filterByRange(const FilterByRangeRequest&) const. More...

#include <gpudb/protocol/filter_by_range.h>

Public Member Functions
	FilterByRangeRequest ()
	Constructs a FilterByRangeRequest object with default parameter values. More...
	FilterByRangeRequest (const std::string &tableName, const std::string &viewName, const std::string &columnName, const double lowerBound, const double upperBound, const std::map< std::string, std::string > &options)
	Constructs a FilterByRangeRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	viewName
std::string	columnName
double	lowerBound
double	upperBound
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for filterByRange(const FilterByRangeRequest&) const.

Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by tableName is added to the view viewName if its column is within [lowerBound, upperBound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Definition at line 26 of file filter_by_range.h.

Constructor & Destructor Documentation

gpudb::FilterByRangeRequest::FilterByRangeRequest ( )

inline

Constructs a FilterByRangeRequest object with default parameter values.

Definition at line 33 of file filter_by_range.h.

gpudb::FilterByRangeRequest::FilterByRangeRequest ( const std::string &  tableName, const std::string &  viewName, const std::string &  columnName, const double  lowerBound, const double  upperBound, const std::map< std::string, std::string > &  options  )

inline

Constructs a FilterByRangeRequest object with the specified parameters.

Parameters

[in]	tableName	Name of the table on which the filter by range operation will be performed. Must be a valid GPUdb table.
[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]	columnName	Name of a column or an expression of one or more columns on which the operation would be applied.
[in]	lowerBound	Value of the lower bound (inclusive).
[in]	upperBound	Value of the upper bound (inclusive).
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 63 of file filter_by_range.h.

Member Data Documentation

std::string gpudb::FilterByRangeRequest::columnName

Definition at line 75 of file filter_by_range.h.

double gpudb::FilterByRangeRequest::lowerBound

Definition at line 76 of file filter_by_range.h.

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

Definition at line 78 of file filter_by_range.h.

std::string gpudb::FilterByRangeRequest::tableName

Definition at line 73 of file filter_by_range.h.

double gpudb::FilterByRangeRequest::upperBound

Definition at line 77 of file filter_by_range.h.

std::string gpudb::FilterByRangeRequest::viewName

Definition at line 74 of file filter_by_range.h.

---

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

• gpudb/protocol/filter_by_range.h