URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/byarea
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.
Name | Type | Description | ||||
---|---|---|---|---|---|---|
table_name | string | Name of the table to filter. This may be the name of a collection, a table, or a view (when chaining queries). If filtering a collection, all child tables where the filter expression is valid will be filtered; the filtered result tables will then be placed in a collection specified by input parameter view_name. | ||||
view_name | string | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. The default value is ''. | ||||
x_column_name | string | Name of the column containing the x values to be filtered. | ||||
x_vector | array of doubles | List of x coordinates of the vertices of the polygon representing the area to be filtered. | ||||
y_column_name | string | Name of the column containing the y values to be filtered. | ||||
y_vector | array of doubles | List of y coordinates of the vertices of the polygon representing the area to be filtered. | ||||
options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
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_area_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/byarea endpoint:
Empty string in case of an error. |