Skip to main content

◆ filterByValue() [1/2]

FilterByValueResponse kinetica.Kinetica.filterByValue (FilterByValueRequestrequest_)
inline

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

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

Definition at line 39966 of file KineticaFunctions.cs.

◆ filterByValue() [2/2]

FilterByValueResponse kinetica.Kinetica.filterByValue (stringtable_name,
stringview_name,
boolis_string,
double_value,
stringvalue_str,
stringcolumn_name,
IDictionary< string, string >options = null )
inline

Calculates which objects from a table has a particular value for a particular column.

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Parameters
table_nameName of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.
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 ”.
is_stringIndicates whether the value being searched for is string or numeric.
_valueThe value to search for. The default value is 0.
value_strThe string value to search for. The default value is ”.
column_nameName of a column on which the filter by value would be applied.
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.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 40078 of file KineticaFunctions.cs.

◆ FilterByValueAsync() [1/2]

async System.Threading.Tasks.Task< FilterByValueResponse > kinetica.Kinetica.FilterByValueAsync (FilterByValueRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
inline

Calculates which objects from a table has a particular value for a particular column.

(async)

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

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

◆ FilterByValueAsync() [2/2]

async System.Threading.Tasks.Task< FilterByValueResponse > kinetica.Kinetica.FilterByValueAsync (stringtable_name,
stringview_name,
boolis_string,
double_value,
stringvalue_str,
stringcolumn_name,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
inline

Calculates which objects from a table has a particular value for a particular column.

(async)

The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

Parameters
table_nameName of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.
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 ”.
is_stringIndicates whether the value being searched for is string or numeric.
_valueThe value to search for. The default value is 0.
value_strThe string value to search for. The default value is ”.
column_nameName of a column on which the filter by value would be applied.
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.
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 40171 of file KineticaFunctions.cs.