Skip to main content

​
◆ filter() [1/2]

FilterResponse kinetica.Kinetica.filter (FilterRequestrequest_)
 inline

Filters data based on the specified expression.

The results are stored in a result set with the given 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.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 36260 of file KineticaFunctions.cs.

​
◆ filter() [2/2]

FilterResponse kinetica.Kinetica.filter (stringtable_name,
stringview_name,
stringexpression,
IDictionary< string, string >options = null )
 inline

Filters data based on the specified expression.

The results are stored in a result set with the given 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.

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 ”.
expressionThe select expression to filter the specified table. For details see Expressions.
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 is non-existent, it will be automatically created.
  • VIEW_ID: View this filtered-view is part of. The default value is ”.
  • TTL: Sets the TTL of the view specified in view_name .
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 36373 of file KineticaFunctions.cs.

​
◆ FilterAsync() [1/2]

async System.Threading.Tasks.Task< FilterResponse > kinetica.Kinetica.FilterAsync (FilterRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Filters data based on the specified expression.

(async)

The results are stored in a result set with the given 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.

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 36285 of file KineticaFunctions.cs.

​
◆ FilterAsync() [2/2]

async System.Threading.Tasks.Task< FilterResponse > kinetica.Kinetica.FilterAsync (stringtable_name,
stringview_name,
stringexpression,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Filters data based on the specified expression.

(async)

The results are stored in a result set with the given 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.

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 ”.
expressionThe select expression to filter the specified table. For details see Expressions.
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 is non-existent, it will be automatically created.
  • VIEW_ID: View this filtered-view is part of. The default value is ”.
  • TTL: Sets the TTL of the view specified in view_name .
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 36464 of file KineticaFunctions.cs.