URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/bygeometry

Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by input parameter input_wkt.

Input Parameter Description

Name Type Description
table_name string 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.
view_name string 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 ''.
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

Supported Values Description
contains Matches records that contain the given WKT in input parameter input_wkt, i.e. the given WKT is within the bounds of a record's geometry.
crosses Matches records that cross the given WKT.
disjoint Matches records that are disjoint from the given WKT.
equals Matches records that are the same as the given WKT.
intersects Matches records that intersect the given WKT.
overlaps Matches records that overlap the given WKT.
touches Matches records that touch the given WKT.
within Matches records that are within the given WKT.
options map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys) Parameter Description

If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter view_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. The default value is false. The supported values are:

  • true
  • false
collection_name [DEPRECATED--please specify the containing schema for the view as part of input parameter view_name and use /create/schema 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.

Output Parameter Description

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_response' 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:

Name Type Description
count long The number of records passing the geometry filter.
info map of string to strings

Additional information. The default value is an empty map ( {} ).

Possible Parameters (keys) Parameter Description
qualified_view_name The fully qualified name of the view (i.e. including the schema)

Empty string in case of an error.