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

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

#include <gpudb/protocol/filter_by_box.h>

Public Member Functions

 FilterByBoxRequest ()
 Constructs a FilterByBoxRequest object with default parameter values. More...
 
 FilterByBoxRequest (const std::string &tableName_, const std::string &viewName_, const std::string &xColumnName_, const double minX_, const double maxX_, const std::string &yColumnName_, const double minY_, const double maxY_, const std::map< std::string, std::string > &options_)
 Constructs a FilterByBoxRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::string viewName
 
std::string xColumnName
 
double minX
 
double maxX
 
std::string yColumnName
 
double minY
 
double maxY
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Calculates how many objects within the given table lie in a rectangular box. 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 which satisfies the input NAI restriction specification is also created when a viewName is passed in as part of the input payload.

Definition at line 23 of file filter_by_box.h.

Constructor & Destructor Documentation

gpudb::FilterByBoxRequest::FilterByBoxRequest ( )
inline

Constructs a FilterByBoxRequest object with default parameter values.

Definition at line 30 of file filter_by_box.h.

gpudb::FilterByBoxRequest::FilterByBoxRequest ( const std::string &  tableName_,
const std::string &  viewName_,
const std::string &  xColumnName_,
const double  minX_,
const double  maxX_,
const std::string &  yColumnName_,
const double  minY_,
const double  maxY_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a FilterByBoxRequest object with the specified parameters.

Parameters
[in]tableName_Name of the table on which the bounding box operation will be performed. Must be an existing table.
[in]viewName_Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables.
[in]xColumnName_Name of the column on which to perform the bounding box query. Must be a valid numeric column.
[in]minX_Lower bound for the column chosen by xColumnName. Must be less than or equal to maxX.
[in]maxX_Upper bound for xColumnName. Must be greater than or equal to minX.
[in]yColumnName_Name of a column on which to perform the bounding box query. Must be a valid numeric column.
[in]minY_Lower bound for yColumnName. Must be less than or equal to maxY.
[in]maxY_Upper bound for yColumnName. Must be greater than or equal to minY.
[in]options_Optional parameters.
  • gpudb::filter_by_box_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 82 of file filter_by_box.h.

Member Data Documentation

double gpudb::FilterByBoxRequest::maxX

Definition at line 99 of file filter_by_box.h.

double gpudb::FilterByBoxRequest::maxY

Definition at line 102 of file filter_by_box.h.

double gpudb::FilterByBoxRequest::minX

Definition at line 98 of file filter_by_box.h.

double gpudb::FilterByBoxRequest::minY

Definition at line 101 of file filter_by_box.h.

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

Definition at line 103 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::tableName

Definition at line 95 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::viewName

Definition at line 96 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::xColumnName

Definition at line 97 of file filter_by_box.h.

std::string gpudb::FilterByBoxRequest::yColumnName

Definition at line 100 of file filter_by_box.h.


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