/filter/byarea

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/byarea

Calculates which objects from a table are within 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.

Note that if you call this endpoint using a table that has WKT data, the x_column_name and y_column_name settings are no longer required because the geospatial filter works automatically.

Input Parameter Description

Name	Type	Description
table_name	string	Name of the table to filter. This may be the name of a collection, a table or a view (when chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
view_name	string	If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. Default value is ''.
x_column_name	string	Name of the column containing the x values 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_column_name	string	Name of the column containing the y values 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 strings	Optional parameters. Default value is an empty map ( {} ).

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_area_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/byarea endpoint: Name Type Description count long The number of records passing the area filter. Empty string in case of an error.