URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/bygeometry
Applies a geometry filter against a geospatial geometry column in a given table, collection or view. The filtering geometry is provided by input parameter input_wkt.
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
table_name | string | Name of the table on which the filter by geometry will be performed. Must be an existing table, collection or view containing a geospatial geometry column. | ||||||||||||||||||
view_name | string | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. | ||||||||||||||||||
column_name | string | Name of the column to be used in the filter. Must be a geospatial geometry column. | ||||||||||||||||||
input_wkt | string | A geometry in WKT format that will be used to filter the objects in input parameter table_name. The default value is ''. | ||||||||||||||||||
operation | string | The geometric filtering operation to perform
|
||||||||||||||||||
options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
status | String | 'OK' or 'ERROR' | |||||||||
message | String | Empty if success or an error message | |||||||||
data_type | String | 'filter_by_geometry_request' or 'none' in case of an error | |||||||||
data | String | Empty string | |||||||||
data_str | JSON or String | This embedded JSON represents the result of the /filter/bygeometry endpoint:
Empty string in case of an error. |