/filter/bybox

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

Calculates how many objects within the given table lie in a rectangular box. The operation is synchronous meaning that GPUdb will not return the request 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 a valid table in GPUdb.
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 in GPUdb. Default value is ''.
x_column_name	string	Name of the column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
min_x	double	Lower bound for the column chosen by input parameter x_column_name. Must be less than or equal to input parameter max_x.
max_x	double	Upper bound for input parameter x_column_name. Must be greater than or equal to input parameter min_x.
y_column_name	string	Name of a column on which to perform the bounding box query. If the table's data type is not a shape type, must be a valid numeric column.
min_y	double	Lower bound for input parameter y_column_name. Must be less than or equal to input parameter max_y.
max_y	double	Upper bound for input parameter y_column_name. Must be greater than or equal to input parameter min_y.
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_box_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 endpoint: Name Type Description count long The number of records passing the box filter. Empty string in case of an error.