Skip to main content
Source

​
pub async fn filter_by_box( &self, table_name: String, view_name: String, x_column_name: String, min_x: f64, max_x: f64, y_column_name: String, min_y: f64, max_y: f64, ) -> Result<FilterByBoxResponse, KineticaError>

Filter a dataset for records within a rectangle’s boundary

Calculates how many objects within the given table lie in a rectangular box. 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 which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.

  • table_name - Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
  • 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.
  • x_column_name - Name of the column on which to perform the bounding box query. Must be a valid numeric column.
  • min_x - Lower bound for the column chosen by x_column_name. Must be less than or equal to max_x.
  • max_x - Upper bound for x_column_name. Must be greater than or equal to min_x.
  • y_column_name - Name of a column on which to perform the bounding box query. Must be a valid numeric column.
  • min_y - Lower bound for y_column_name. Must be less than or equal to max_y.
  • max_y - Upper bound for y_column_name. Must be greater than or equal to min_y.
Source

​
pub async fn filter_by_box_with_opts( &self, table_name: String, view_name: String, x_column_name: String, min_x: f64, max_x: f64, y_column_name: String, min_y: f64, max_y: f64, options: FilterByBoxRequestOptions, ) -> Result<FilterByBoxResponse, KineticaError>

Filter a dataset for records within a rectangle’s boundary

Calculates how many objects within the given table lie in a rectangular box. 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 which satisfies the input NAI restriction specification is also created when a view_name is passed in as part of the input payload.

  • table_name - Name of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
  • 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.
  • x_column_name - Name of the column on which to perform the bounding box query. Must be a valid numeric column.
  • min_x - Lower bound for the column chosen by x_column_name. Must be less than or equal to max_x.
  • max_x - Upper bound for x_column_name. Must be greater than or equal to min_x.
  • y_column_name - Name of a column on which to perform the bounding box query. Must be a valid numeric column.
  • min_y - Lower bound for y_column_name. Must be less than or equal to max_y.
  • max_y - Upper bound for y_column_name. Must be greater than or equal to min_y.
  • options - The optional parameters; any left unset take the server’s defaults.

Sends a pre-built FilterByBoxRequest to the /filter/bybox endpoint.

Sends a pre-built FilterByBoxRequest to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.