Calculates which records from a table have values in the given list for the
corresponding column. 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 resultant set (view)
which satisfies the input filter specification is also created if a input
parameter view_name is passed in as part of the request.For example, if a type definition has the columns ‘x’ and ‘y’, then a filter by
list query with the column map {“x”:[“10.1”, “2.3”], “y”:[“0.0”, “-31.5”,
“42.0”]} will return the count of all data points whose x and y values match
both in the respective x- and y-lists, e.g., “x = 10.1 and y = 0.0”, “x = 2.3
and y = -31.5”, etc. However, a record with “x = 10.1 and y = -31.5” or “x =
2.3 and y = 0.0” would not be returned because the values in the given lists do
not correspond.
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 ”.
map of string to arrays of strings
List of values for the corresponding column in the table.
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 provided is non-existent, it will be automatically created.
String indicating the filter mode, either ‘in_list’ or ‘not_in_list’.The default value is in_list.
in_list: The filter will match all items that are in the provided list(s).
not_in_list: The filter will match all items that are not in the provided list(s).
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_by_list_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /filter/bylist endpoint:
Show data_str
long
The number of records passing the list filter.
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.