GPUdb C++ API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
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 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. Has the same naming restrictions as tables.
[in]expression_The select expression to filter the specified table. For details see concepts.
[in]options_Optional parameters.
  • gpudb::filter_collection_name: Name of a collection which is to contain the newly created view, otherwise the view will be a top-level table. If the collection does not allow duplicate types and it contains a table of the same type as the given one, then this table creation request will fail.
  • gpudb::filter_ttl: Sets the TTL of the view specified in viewName. The value must be the desired TTL in minutes.

Definition at line 72 of file filter.h.

Member Data Documentation

std::string gpudb::FilterRequest::expression

Definition at line 82 of file filter.h.

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

Definition at line 83 of file filter.h.

std::string gpudb::FilterRequest::tableName

Definition at line 80 of file filter.h.

std::string gpudb::FilterRequest::viewName

Definition at line 81 of file filter.h.


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