Skip to main content
Source

pub async fn filter_by_area( &self, table_name: String, view_name: String, x_column_name: String, x_vector: Vec<f64>, y_column_name: String, y_vector: Vec<f64>, ) -> Result<FilterByAreaResponse, KineticaError>

Filter a dataset for records falling within a 2-D polygon’s boundary

Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.

  • table_name - Name 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_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 containing the x values to be filtered.
  • x_vector - List of x coordinates of the vertices of the polygon representing the area to be filtered.
  • y_column_name - Name of the column containing the y values to be filtered.
  • y_vector - List of y coordinates of the vertices of the polygon representing the area to be filtered.
Source

pub async fn filter_by_area_with_opts( &self, table_name: String, view_name: String, x_column_name: String, x_vector: Vec<f64>, y_column_name: String, y_vector: Vec<f64>, options: FilterByAreaRequestOptions, ) -> Result<FilterByAreaResponse, KineticaError>

Filter a dataset for records falling within a 2-D polygon’s boundary

Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name view_name passed in as part of the input.

  • table_name - Name 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_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 containing the x values to be filtered.
  • x_vector - List of x coordinates of the vertices of the polygon representing the area to be filtered.
  • y_column_name - Name of the column containing the y values to be filtered.
  • y_vector - List of y coordinates of the vertices of the polygon representing the area to be filtered.
  • options - The optional parameters; any left unset take the server’s defaults.

Sends a pre-built FilterByAreaRequest to the /filter/byarea endpoint.

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