filter_by_box

GPUdb.filter_by_box( table_name = None, view_name = '', x_column_name = None,
                     min_x = None, max_x = None, y_column_name = None, min_y
                     = None, max_y = None, options = {} )

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

Name	Type	Description
table_name	str	Name of the table on which the bounding box operation will be performed. Must be an existing table.
view_name	str	Optional name of the result view that will be created containing the results of the query. Has the same naming restrictions as tables. Default value is ''.
x_column_name	str	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	float	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	float	Upper bound for input parameter x_column_name. Must be greater than or equal to input parameter min_x.
y_column_name	str	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	float	Lower bound for input parameter y_column_name. Must be less than or equal to input parameter max_y.
max_y	float	Upper bound for input parameter y_column_name. Must be greater than or equal to input parameter min_y.
options	dict of str	Optional parameters. Default value is an empty dict ( {} ).

Output Parameter Description

Name	Type	Description
count	long	The number of records passing the box filter.