A set of parameters for GPUdb::filterByBoxGeometry. More…
#include <gpudb/protocol/filter_by_box_geometry.h>
Public Member Functions | |
| FilterByBoxGeometryRequest () | |
| Constructs a FilterByBoxGeometryRequest object with default parameters. | |
| FilterByBoxGeometryRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const double minX_, const double maxX_, const double minY_, const double maxY_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterByBoxGeometryRequest 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 | columnName |
| Name of the geospatial geometry column to be filtered. | |
| double | minX |
| Lower bound for the x-coordinate of the rectangular box. | |
| double | maxX |
| Upper bound for the x-coordinate of the rectangular box. | |
| double | minY |
| Lower bound for the y-coordinate of the rectangular box. | |
| double | maxY |
| Upper bound for the y-coordinate of the rectangular box. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByBoxGeometry.
Calculates which geospatial geometry objects from a table intersect 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 24 of file filter_by_box_geometry.h.
Constructor & Destructor Documentation
◆ FilterByBoxGeometryRequest() [1/2]
| inline |
Constructs a FilterByBoxGeometryRequest object with default parameters.
Definition at line 30 of file filter_by_box_geometry.h.
◆ FilterByBoxGeometryRequest() [2/2]
| inline |
Constructs a FilterByBoxGeometryRequest 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] | columnName_ | Name of the geospatial geometry column to be filtered. |
| [in] | minX_ | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to maxX_. |
| [in] | maxX_ | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to minX_. |
| [in] | minY_ | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to maxY_. |
| [in] | maxY_ | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to minY_. |
| [in] | options_ | Optional parameters.
|
Definition at line 121 of file filter_by_box_geometry.h.
Member Data Documentation
◆ columnName
| std::string gpudb::FilterByBoxGeometryRequest::columnName |
Name of the geospatial geometry column to be filtered.
Definition at line 155 of file filter_by_box_geometry.h.
◆ maxX
| double gpudb::FilterByBoxGeometryRequest::maxX |
Upper bound for the x-coordinate of the rectangular box.
Must be greater than or equal to minX.
Definition at line 167 of file filter_by_box_geometry.h.
◆ maxY
| double gpudb::FilterByBoxGeometryRequest::maxY |
Upper bound for the y-coordinate of the rectangular box.
Must be greater than or equal to minY.
Definition at line 179 of file filter_by_box_geometry.h.
◆ minX
| double gpudb::FilterByBoxGeometryRequest::minX |
Lower bound for the x-coordinate of the rectangular box.
Must be less than or equal to maxX.
Definition at line 161 of file filter_by_box_geometry.h.
◆ minY
| double gpudb::FilterByBoxGeometryRequest::minY |
Lower bound for the y-coordinate of the rectangular box.
Must be less than or equal to maxY.
Definition at line 173 of file filter_by_box_geometry.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByBoxGeometryRequest::options |
Optional parameters.
- filter_by_box_geometry_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_geometry_false.
- filter_by_box_geometry_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 provided is non-existent, it will be automatically created.
The default value is an empty map.
Definition at line 214 of file filter_by_box_geometry.h.
◆ tableName
| std::string gpudb::FilterByBoxGeometryRequest::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 139 of file filter_by_box_geometry.h.
◆ viewName
| std::string gpudb::FilterByBoxGeometryRequest::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 150 of file filter_by_box_geometry.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_box_geometry.h