> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# filter_by_radius_geometry

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_radius_geometry.rs#L40-L59)
pub async fn [filter\_by\_radius\_geometry](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-radius-geometry.md#method.filter_by_radius_geometry)( \&self, table\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), view\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), x\_center: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), y\_center: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), radius: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByRadiusGeometryResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Filter a dataset for geospatial geometry objects intersecting a circle’s boundaryCalculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). 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 (view) which satisfies the input circular NAI restriction specification is also created if a `view_name` is passed in as part of the request.

##### Arguments

<ul>
  <li>`table_name` - Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.</li>
  <li>`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.</li>
  <li>`column_name` - Name of the geospatial geometry column to be filtered.</li>
  <li>`x_center` - Value of the longitude of the center. Must be within \[-180.0, 180.0].</li>
  <li>`y_center` - Value of the latitude of the center. Must be within \[-90.0, 90.0].</li>
  <li>`radius` - The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of ‘42000’ means 42 km.</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_radius_geometry.rs#L91-L117)
pub async fn [filter\_by\_radius\_geometry\_with\_opts](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-radius-geometry.md#method.filter_by_radius_geometry_with_opts)( \&self, table\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), view\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), column\_name: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), x\_center: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), y\_center: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), radius: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), options: [FilterByRadiusGeometryRequestOptions](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryRequestOptions.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByRadiusGeometryResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Filter a dataset for geospatial geometry objects intersecting a circle’s boundaryCalculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). 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 (view) which satisfies the input circular NAI restriction specification is also created if a `view_name` is passed in as part of the request.

##### Arguments

<ul>
  <li>`table_name` - Name of the table on which the filter by radius operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.</li>
  <li>`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.</li>
  <li>`column_name` - Name of the geospatial geometry column to be filtered.</li>
  <li>`x_center` - Value of the longitude of the center. Must be within \[-180.0, 180.0].</li>
  <li>`y_center` - Value of the latitude of the center. Must be within \[-90.0, 90.0].</li>
  <li>`radius` - The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of ‘42000’ means 42 km.</li>
  <li>`options` - The optional parameters; any left unset take the server’s defaults.</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_radius_geometry.rs#L120-L131)
pub async fn [filter\_by\_radius\_geometry\_raw](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-radius-geometry.md#method.filter_by_radius_geometry_raw)( \&self, request: &[FilterByRadiusGeometryRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByRadiusGeometryResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`FilterByRadiusGeometryRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryRequest) to the `/filter/byradius/geometry` endpoint.

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_radius_geometry.rs#L135-L147)
pub async fn [filter\_by\_radius\_geometry\_from\_url](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-radius-geometry.md#method.filter_by_radius_geometry_from_url)( \&self, url: &[str](https://doc.rust-lang.org/1.98.1/std/primitive.str.html), request: &[FilterByRadiusGeometryRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByRadiusGeometryResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Sends a pre-built [`FilterByRadiusGeometryRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByRadiusGeometryRequest) to a specific worker URL, bypassing HA head-node selection. Used for multi-head access.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.