URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter/byvalue
Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.
Input Parameter Description
| Name | Type | Description |
|---|---|---|
| table_name | string | Name of an existing table on which to perform the calculation. |
| view_name | string | If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. Default value is ''. |
| is_string | boolean | Indicates whether the value being searched for is string or numeric. |
| value | double | The value to search for. Default value is 0. |
| value_str | string | The string value to search for. Default value is ''. |
| column_name | string | Name of a column on which the filter by value would be applied. |
| options | map of strings | Optional parameters. Default value is an empty map ( {} ). |
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_value_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/byvalue endpoint:
Empty string in case of an error. |