/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 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

NameTypeDescription
table_namestringName of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
view_namestringIf 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 ''.
x_column_namestringName of the column on which to perform the bounding box query. Must be a valid numeric column.
min_xdoubleLower bound for the column chosen by input parameter x_column_name. Must be less than or equal to input parameter max_x.
max_xdoubleUpper bound for input parameter x_column_name. Must be greater than or equal to input parameter min_x.
y_column_namestringName of a column on which to perform the bounding box query. Must be a valid numeric column.
min_ydoubleLower bound for input parameter y_column_name. Must be less than or equal to input parameter max_y.
max_ydoubleUpper bound for input parameter y_column_name. Must be greater than or equal to input parameter min_y.
optionsmap 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] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.

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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'filter_by_box_request' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /filter/bybox endpoint:

NameTypeDescription
countlongThe number of records passing the box filter.
infomap of string to strings

Additional information. The default value is an empty map ( {} ).

Possible Parameters (keys)Parameter Description
qualified_view_nameThe fully qualified name of the view (i.e. including the schema)

Empty string in case of an error.