/filter/bybox/geometry

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/bybox/geometry

Calculates which geospatial geometry objects from a table intersect a rectangular box. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new resultant set which satisfies the input NAI restriction specification is also created when a input parameter view_name is passed in as part of the input payload.

Input Parameter Description

Name	Type	Description
table_name	string	Name of the table on which the bounding box operation will be performed. Must be an existing table.
view_name	string	Optional name of the result view that will be created containing the results of the query. Must not be an already existing collection, table or view. The default value is ''.
column_name	string	Name of the geospatial geometry column to be filtered.
min_x	double	Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to input parameter max_x.
max_x	double	Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to input parameter min_x.
min_y	double	Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to input parameter max_y.
max_y	double	Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to input parameter min_y.
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

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