Skip to main content

​
◆ filterByList() [1/2]

FilterByListResponse kinetica.Kinetica.filterByList (FilterByListRequestrequest_)
 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 37798 of file KineticaFunctions.cs.

​
◆ filterByList() [2/2]

FilterByListResponse kinetica.Kinetica.filterByList (stringtable_name,
stringview_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_nameName 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_nameIf 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_mapList of values for the corresponding column in the table.
optionsOptional 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 37941 of file KineticaFunctions.cs.

​
◆ FilterByListAsync() [1/2]

async System.Threading.Tasks.Task< FilterByListResponse > kinetica.Kinetica.FilterByListAsync (FilterByListRequestrequest_,
System.Threading.CancellationTokencancellationToken = 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 37829 of file KineticaFunctions.cs.

​
◆ FilterByListAsync() [2/2]

async System.Threading.Tasks.Task< FilterByListResponse > kinetica.Kinetica.FilterByListAsync (stringtable_name,
stringview_name,
IDictionary< string, IList< string > >column_values_map,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = 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_nameName 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_nameIf 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_mapList of values for the corresponding column in the table.
optionsOptional 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.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 38056 of file KineticaFunctions.cs.