/filter/bygeometry

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

NameTypeDescription
table_namestringName 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_namestringIf 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_namestringName of the column to be used in the filter. Must be a geospatial geometry column.
input_wktstringA geometry in WKT format that will be used to filter the objects in input parameter table_name. The default value is ''.
operationstring

The geometric filtering operation to perform

Supported ValuesDescription
containsMatches 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.
crossesMatches records that cross the given WKT.
disjointMatches records that are disjoint from the given WKT.
equalsMatches records that are the same as the given WKT.
intersectsMatches records that intersect the given WKT.
overlapsMatches records that overlap the given WKT.
touchesMatches records that touch the given WKT.
withinMatches records that are within the given WKT.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'filter_by_geometry_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /filter/bygeometry endpoint:

NameTypeDescription
countlongThe number of records passing the geometry filter.
infomap of string to strings

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

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

Empty string in case of an error.