/filter/byrange

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/byrange

Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by input parameter table_name is added to the view input parameter view_name if its column is within [input parameter lower_bound, input parameter upper_bound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Input Parameter Description

Name	Type	Description
table_name	string	Name of the table on which the filter by range operation will be performed. Must be an existing table.
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 ''.
column_name	string	Name of a column on which the operation would be applied.
lower_bound	double	Value of the lower bound (inclusive).
upper_bound	double	Value of the upper bound (inclusive).
options	map of string to strings	Optional parameters. The default value is an empty map ( {} ). Supported Parameters (keys) Parameter Description collection_name Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.

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_range_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/byrange endpoint: Name Type Description count long The number of records passing the range filter. info map of string to strings Additional information. Empty string in case of an error.