filter_by_area

GPUdb.filter_by_area( table_name = None, view_name = '', x_column_name = None,
                      x_vector = None, y_column_name = None, y_vector = None,
                      options = {} )

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	str	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	str	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	str	Name of the column containing the x values to be filtered.
x_vector	list of floats	List of x coordinates of the vertices of the polygon representing the area to be filtered.
y_column_name	str	Name of the column containing the y values to be filtered.
y_vector	list of floats	List of y coordinates of the vertices of the polygon representing the area to be filtered.
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 area filter.