GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::FilterRequest Struct Reference

A set of input parameters for 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 const.

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

For details see Expressions.

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 27 of file filter.h.

Constructor & Destructor Documentation

gpudb::FilterRequest::FilterRequest ( )
inline

Constructs a FilterRequest object with default parameter values.

Definition at line 33 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 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]expression_The select expression to filter the specified table. For details see Expressions.
[in]options_Optional parameters.
  • gpudb::filter_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_view_id: view this filtered-view is part of. The default value is ''.
  • gpudb::filter_ttl: Sets the TTL of the view specified in viewName.

Definition at line 78 of file filter.h.

Member Data Documentation

std::string gpudb::FilterRequest::expression

Definition at line 88 of file filter.h.

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

Definition at line 89 of file filter.h.

std::string gpudb::FilterRequest::tableName

Definition at line 86 of file filter.h.

std::string gpudb::FilterRequest::viewName

Definition at line 87 of file filter.h.


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