A set of parameters for GPUdb::filterByBox. More…
#include <gpudb/protocol/filter_by_box.h>
Public Member Functions | |
| FilterByBoxRequest () | |
| Constructs a FilterByBoxRequest object with default parameters. | |
| 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. | |
Public Attributes | |
| std::string | tableName |
| Name of the table on which the bounding box operation will be performed, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| std::string | viewName |
| If provided, then this will be the name of the view containing the results, in [ schema_name. ]view_name format, using standard name resolution rules and meeting table naming criteria. | |
| std::string | xColumnName |
| Name of the column on which to perform the bounding box query. | |
| double | minX |
| Lower bound for the column chosen by xColumnName. | |
| double | maxX |
| Upper bound for xColumnName. | |
| std::string | yColumnName |
| Name of a column on which to perform the bounding box query. | |
| double | minY |
| Lower bound for yColumnName. | |
| double | maxY |
| Upper bound for yColumnName. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByBox.
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
◆ FilterByBoxRequest() [1/2]
| inline |
Constructs a FilterByBoxRequest object with default parameters.
Definition at line 28 of file filter_by_box.h.
◆ FilterByBoxRequest() [2/2]
| inline |
Constructs a FilterByBoxRequest object with the specified parameters.
| [in] | tableName_ | Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. |
| [in] | viewName_ | If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ”. |
| [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.
|
Definition at line 117 of file filter_by_box.h.
Member Data Documentation
◆ maxX
| double gpudb::FilterByBoxRequest::maxX |
Upper bound for xColumnName.
Must be greater than or equal to minX.
Definition at line 165 of file filter_by_box.h.
◆ maxY
| double gpudb::FilterByBoxRequest::maxY |
Upper bound for yColumnName.
Must be greater than or equal to minY.
Definition at line 183 of file filter_by_box.h.
◆ minX
| double gpudb::FilterByBoxRequest::minX |
Lower bound for the column chosen by xColumnName.
Must be less than or equal to maxX.
Definition at line 159 of file filter_by_box.h.
◆ minY
| double gpudb::FilterByBoxRequest::minY |
Lower bound for yColumnName.
Must be less than or equal to maxY.
Definition at line 177 of file filter_by_box.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByBoxRequest::options |
Optional parameters.
- filter_by_box_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of viewName. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. Supported values:The default value is filter_by_box_false.
- filter_by_box_collection_name: [DEPRECATED–please specify the containing schema for the view as part of viewName and use GPUdb::createSchema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
The default value is an empty map.
Definition at line 216 of file filter_by_box.h.
◆ tableName
| std::string gpudb::FilterByBoxRequest::tableName |
Name of the table on which the bounding box operation will be performed, in [ schema_name. ]table_name format, using standard name resolution rules.
Must be an existing table.
Definition at line 136 of file filter_by_box.h.
◆ viewName
| std::string gpudb::FilterByBoxRequest::viewName |
If provided, then this will be the name of the view containing the results, in [ schema_name. ]view_name format, using standard name resolution rules and meeting table naming criteria.
Must not be an already existing table or view. The default value is ”.
Definition at line 147 of file filter_by_box.h.
◆ xColumnName
| std::string gpudb::FilterByBoxRequest::xColumnName |
Name of the column on which to perform the bounding box query.
Must be a valid numeric column.
Definition at line 153 of file filter_by_box.h.
◆ yColumnName
| std::string gpudb::FilterByBoxRequest::yColumnName |
Name of a column on which to perform the bounding box query.
Must be a valid numeric column.
Definition at line 171 of file filter_by_box.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_box.h