A set of parameters for GPUdb::filterByGeometry. More…
#include <gpudb/protocol/filter_by_geometry.h>
Public Member Functions | |
| FilterByGeometryRequest () | |
| Constructs a FilterByGeometryRequest object with default parameters. | |
| FilterByGeometryRequest (const std::string &tableName_, const std::string &viewName_, const std::string &columnName_, const std::string &inputWkt_, const std::string &operation_, const std::map< std::string, std::string > &options_) | |
| Constructs a FilterByGeometryRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of the table on which the filter by geometry 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 column to be used in the filter. | |
| std::string | inputWkt |
| A geometry in WKT format that will be used to filter the objects in tableName. | |
| std::string | operation |
| The geometric filtering operation to perform. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::filterByGeometry.
Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by inputWkt.
Definition at line 20 of file filter_by_geometry.h.
Constructor & Destructor Documentation
◆ FilterByGeometryRequest() [1/2]
| inline |
Constructs a FilterByGeometryRequest object with default parameters.
Definition at line 25 of file filter_by_geometry.h.
◆ FilterByGeometryRequest() [2/2]
| inline |
Constructs a FilterByGeometryRequest object with the specified parameters.
| [in] | tableName_ | Name of the table on which the filter by geometry will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column. |
| [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 column to be used in the filter. Must be a geospatial geometry column. |
| [in] | inputWkt_ | A geometry in WKT format that will be used to filter the objects in tableName_. The default value is ”. |
| [in] | operation_ | The geometric filtering operation to perform. Supported values:
|
| [in] | options_ | Optional parameters.
|
Definition at line 147 of file filter_by_geometry.h.
Member Data Documentation
◆ columnName
| std::string gpudb::FilterByGeometryRequest::columnName |
Name of the column to be used in the filter.
Must be a geospatial geometry column.
Definition at line 181 of file filter_by_geometry.h.
◆ inputWkt
| std::string gpudb::FilterByGeometryRequest::inputWkt |
A geometry in WKT format that will be used to filter the objects in tableName.
The default value is ”.
Definition at line 187 of file filter_by_geometry.h.
◆ operation
| std::string gpudb::FilterByGeometryRequest::operation |
The geometric filtering operation to perform.
Supported values:
- filter_by_geometry_contains: Matches records that contain the given WKT in inputWkt, i.e. the given WKT is within the bounds of a record’s geometry.
- filter_by_geometry_crosses: Matches records that cross the given WKT.
- filter_by_geometry_disjoint: Matches records that are disjoint from the given WKT.
- filter_by_geometry_equals: Matches records that are the same as the given WKT.
- filter_by_geometry_intersects: Matches records that intersect the given WKT.
- filter_by_geometry_overlaps: Matches records that overlap the given WKT.
- filter_by_geometry_touches: Matches records that touch the given WKT.
- filter_by_geometry_within: Matches records that are within the given WKT.
Definition at line 220 of file filter_by_geometry.h.
◆ options
| std::map<std::string, std::string> gpudb::FilterByGeometryRequest::options |
Optional parameters.
- filter_by_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_geometry_false.
- filter_by_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 254 of file filter_by_geometry.h.
◆ tableName
| std::string gpudb::FilterByGeometryRequest::tableName |
Name of the table on which the filter by geometry will be performed, in [ schema_name. ]table_name format, using standard name resolution rules.
Must be an existing table or view containing a geospatial geometry column.
Definition at line 164 of file filter_by_geometry.h.
◆ viewName
| std::string gpudb::FilterByGeometryRequest::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 175 of file filter_by_geometry.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/filter_by_geometry.h