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 Expressions.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
string
Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
string
If provided, then this will be the name of the view containing the results, in [schema_name.]view_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view.The default value is ”.
string
The select expression to filter the specified table. For details see Expressions.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter view_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name.The default value is false.The supported values are:
true
false
[DEPRECATED—please specify the containing schema for the view as part of input parameter view_name and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.
View this filtered-view is part of.The default value is ”.
Sets the TTL of the view specified in input parameter view_name.
Output Parameter Description
The Kinetica 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:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘filter_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /filter endpoint:
Show data_str
long
The number of records that matched the given select expression.
map of string to strings
Additional information.The default value is an empty map ( {} ).
Show info
The fully qualified name of the view (i.e. including the schema).
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.