Skip to main content

​
◆ filterByRange() [1/2]

FilterByRangeResponse kinetica.Kinetica.filterByRange (FilterByRangeRequestrequest_)
 inline

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by table_name is added to the view view_name if its column is within [lower_bound, upper_bound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

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

Definition at line 38541 of file KineticaFunctions.cs.

​
◆ filterByRange() [2/2]

FilterByRangeResponse kinetica.Kinetica.filterByRange (stringtable_name,
stringview_name,
stringcolumn_name,
doublelower_bound,
doubleupper_bound,
IDictionary< string, string >options = null )
 inline

Calculates which objects from a table have a column that is within the given bounds.

An object from the table identified by table_name is added to the view view_name if its column is within [lower_bound , upper_bound ] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters
table_nameName of the table on which the filter by range operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
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_nameName of a column on which the operation would be applied.
lower_boundValue of the lower bound (inclusive).
upper_boundValue of the upper bound (inclusive).
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 38653 of file KineticaFunctions.cs.

​
◆ FilterByRangeAsync() [1/2]

async System.Threading.Tasks.Task< FilterByRangeResponse > kinetica.Kinetica.FilterByRangeAsync (FilterByRangeRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Calculates which objects from a table have a column that is within the given bounds.

(async)

An object from the table identified by table_name is added to the view view_name if its column is within [lower_bound, upper_bound] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

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

​
◆ FilterByRangeAsync() [2/2]

async System.Threading.Tasks.Task< FilterByRangeResponse > kinetica.Kinetica.FilterByRangeAsync (stringtable_name,
stringview_name,
stringcolumn_name,
doublelower_bound,
doubleupper_bound,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Calculates which objects from a table have a column that is within the given bounds.

(async)

An object from the table identified by table_name is added to the view view_name if its column is within [lower_bound , upper_bound ] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track).

Parameters
table_nameName of the table on which the filter by range operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
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_nameName of a column on which the operation would be applied.
lower_boundValue of the lower bound (inclusive).
upper_boundValue of the upper bound (inclusive).
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 38742 of file KineticaFunctions.cs.