Version:

Filter Geometry by Area

Calculates which geospatial geometry objects from a table intersect a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name input parameter view_name passed in as part of the input.

Input Parameter Description

Name Type Description
table_name string Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
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 geospatial geometry column to be filtered.
x_vector array of doubles List of x coordinates of the vertices of the polygon representing the area to be filtered.
y_vector array of doubles List of y coordinates of the vertices of the polygon representing the area to be filtered.
options map 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] The schema for the newly created view. If the schema is non-existent, it will be automatically created.

Output Parameter Description

Name Type Description
count long The number of records passing the area 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)