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

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 28 of file filter_by_range.h.

Constructor & Destructor Documentation

◆ FilterByRangeRequest() [1/2]

gpudb::FilterByRangeRequest::FilterByRangeRequest ( )

inline

Constructs a FilterByRangeRequest object with default parameter values.

Definition at line 35 of file filter_by_range.h.

◆ FilterByRangeRequest() [2/2]

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 an existing table.
[in]	viewName_	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
[in]	columnName_	Name of a column 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. gpudb::filter_by_range_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 73 of file filter_by_range.h.

Member Data Documentation

◆ columnName

std::string gpudb::FilterByRangeRequest::columnName

Definition at line 85 of file filter_by_range.h.

◆ lowerBound

double gpudb::FilterByRangeRequest::lowerBound

Definition at line 86 of file filter_by_range.h.

◆ options

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

Definition at line 88 of file filter_by_range.h.

◆ tableName

std::string gpudb::FilterByRangeRequest::tableName

Definition at line 83 of file filter_by_range.h.

◆ upperBound

double gpudb::FilterByRangeRequest::upperBound

Definition at line 87 of file filter_by_range.h.

◆ viewName

std::string gpudb::FilterByRangeRequest::viewName

Definition at line 84 of file filter_by_range.h.

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

gpudb/protocol/filter_by_range.h

Public Member Functions

Public Attributes