> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # filterByList

◆ filterByList() \[1/2]

FilterByListResponse kinetica.Kinetica.filterByList ( FilterByListRequest request\_ )
inline

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 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.

Parameters
request\_ Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 38008 of file KineticaFunctions.cs.

◆ filterByList() \[2/2]

FilterByListResponse kinetica.Kinetica.filterByList ( string table\_name,
string view\_name,
IDictionary\< string, IList\< string > > column\_values\_map,
IDictionary\< string, string > options = null )
inline

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 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.

Parameters
table\_name 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).
view\_name 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 ''.
column\_values\_map List of values for the corresponding column in the table.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of 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. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use createSchema 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.
  • FILTER\_MODE: String indicating the filter mode, either 'in\_list' or 'not\_in\_list'. Supported values:
    • 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).
    The default value is IN\_LIST.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 38151 of file KineticaFunctions.cs.

◆ FilterByListAsync() \[1/2]

async System.Threading.Tasks.Task\< FilterByListResponse > kinetica.Kinetica.FilterByListAsync ( FilterByListRequest request\_,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates which records from a table have values in the given list for the corresponding column.

(async)

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 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.

Parameters
request\_ Request object containing the parameters for the operation.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 38039 of file KineticaFunctions.cs.

◆ FilterByListAsync() \[2/2]

async System.Threading.Tasks.Task\< FilterByListResponse > kinetica.Kinetica.FilterByListAsync ( string table\_name,
string view\_name,
IDictionary\< string, IList\< string > > column\_values\_map,
IDictionary\< string, string > options = null,
System.Threading.CancellationToken cancellationToken = default )
inline

Calculates which records from a table have values in the given list for the corresponding column.

(async)

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 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.

Parameters
table\_name 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).
view\_name 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 ''.
column\_values\_map List of values for the corresponding column in the table.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of 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. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use createSchema 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.
  • FILTER\_MODE: String indicating the filter mode, either 'in\_list' or 'not\_in\_list'. Supported values:
    • 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).
    The default value is IN\_LIST.
The default value is an empty Dictionary.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 38266 of file KineticaFunctions.cs.

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.