URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/filter
Filters data based on the specified expression. The results are stored in a result set with the given input parameter view_name.
For details see concepts.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
Input Parameter Description
| Name | Type | Description |
|---|---|---|
| table_name | string | Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID. |
| view_name | string | If provided, then this will be the name of the view containing the results. Must not be an already existing collection, table or view . Default value is ''. |
| expression | string | The select expression GPUdb uses to filter the specified table. For details see concepts. |
| 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_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 endpoint:
Empty string in case of an error. |