Filter by Geometry

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.

Input Parameter Description

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

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
collection_name Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.

Output Parameter Description

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