gpudb::FilterRequest Struct Reference

A set of input parameters for filter(const FilterRequest&) const. More...

#include <gpudb/protocol/filter.h>

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

Public Attributes
std::string	tableName
std::string	viewName
std::string	expression
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for filter(const FilterRequest&) const.

Filters data based on the specified expression. The results are stored in a result set with the given viewName.

For details see concepts.

The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.

Definition at line 26 of file filter.h.

Constructor & Destructor Documentation

gpudb::FilterRequest::FilterRequest ( )

inline

Constructs a FilterRequest object with default parameter values.

Definition at line 32 of file filter.h.

gpudb::FilterRequest::FilterRequest ( const std::string &  tableName, const std::string &  viewName, const std::string &  expression, const std::map< std::string, std::string > &  options  )

inline

Constructs a FilterRequest object with the specified parameters.

Parameters

[in]	tableName	Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
[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]	expression	The select expression GPUdb uses to filter the specified table. For details see concepts.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 60 of file filter.h.

Member Data Documentation

std::string gpudb::FilterRequest::expression

Definition at line 70 of file filter.h.

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

Definition at line 71 of file filter.h.

std::string gpudb::FilterRequest::tableName

Definition at line 68 of file filter.h.

std::string gpudb::FilterRequest::viewName

Definition at line 69 of file filter.h.

---

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

• gpudb/protocol/filter.h