gpudb::FilterByListRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/filter_by_list.h>

Public Member Functions
	FilterByListRequest ()
	Constructs a FilterByListRequest object with default parameter values. More...
	FilterByListRequest (const std::string &tableName_, const std::string &viewName_, const std::map< std::string, std::vector< std::string > > &columnValuesMap_, const std::map< std::string, std::string > &options_)
	Constructs a FilterByListRequest object with the specified parameters. More...

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

Detailed Description

A set of input parameters for const.

Calculates which records from a table have values in the given list for the corresponding column. 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 resultant set (view) which satisfies the input filter specification is also created if a viewName is passed in as part of the request.

For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map {"x":["10.1", "2.3"], "y":["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

Definition at line 31 of file filter_by_list.h.

Constructor & Destructor Documentation

gpudb::FilterByListRequest::FilterByListRequest ( )

inline

Constructs a FilterByListRequest object with default parameter values.

Definition at line 38 of file filter_by_list.h.

gpudb::FilterByListRequest::FilterByListRequest ( const std::string &  tableName_, const std::string &  viewName_, const std::map< std::string, std::vector< std::string > > &  columnValuesMap_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a FilterByListRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by viewName.
[in]	viewName_	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables.
[in]	columnValuesMap_	List of values for the corresponding column in the table
[in]	options_	Optional parameters. gpudb::filter_by_list_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. gpudb::filter_by_list_filter_mode: String indicating the filter mode, either 'in_list' or 'not_in_list'. gpudb::filter_by_list_in_list: The filter will match all items that are in the provided list(s). gpudb::filter_by_list_not_in_list: The filter will match all items that are not in the provided list(s). The default value is gpudb::filter_by_list_in_list.

Definition at line 89 of file filter_by_list.h.

Member Data Documentation

std::map<std::string, std::vector<std::string> > gpudb::FilterByListRequest::columnValuesMap

Definition at line 99 of file filter_by_list.h.

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

Definition at line 100 of file filter_by_list.h.

std::string gpudb::FilterByListRequest::tableName

Definition at line 97 of file filter_by_list.h.

std::string gpudb::FilterByListRequest::viewName

Definition at line 98 of file filter_by_list.h.

---

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

• gpudb/protocol/filter_by_list.h