> ## 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_value

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_value.rs#L40-L59)
pub async fn [filter\_by\_value](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-value.md#method.filter_by_value)( \&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), is\_string: [bool](https://doc.rust-lang.org/1.98.1/std/primitive.bool.html), value: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), value\_str: [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), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByValueResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByValueResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Filter a dataset for records matching a specific valueCalculates 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.

##### Arguments

<ul>
  <li>`table_name` - Name of an existing table on which to perform the calculation, in \[schema\_name.]table\_name format, using standard name resolution rules.</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>`is_string` - Indicates whether the value being searched for is string or numeric.</li>
  <li>`value` - The value to search for.</li>
  <li>`value_str` - The string value to search for.</li>
  <li>`column_name` - Name of a column on which the filter by value would be applied.</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_value.rs#L91-L117)
pub async fn [filter\_by\_value\_with\_opts](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-value.md#method.filter_by_value_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), is\_string: [bool](https://doc.rust-lang.org/1.98.1/std/primitive.bool.html), value: [f64](https://doc.rust-lang.org/1.98.1/std/primitive.f64.html), value\_str: [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), options: [FilterByValueRequestOptions](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByValueRequestOptions.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByValueResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByValueResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Filter a dataset for records matching a specific valueCalculates 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.

##### Arguments

<ul>
  <li>`table_name` - Name of an existing table on which to perform the calculation, in \[schema\_name.]table\_name format, using standard name resolution rules.</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>`is_string` - Indicates whether the value being searched for is string or numeric.</li>
  <li>`value` - The value to search for.</li>
  <li>`value_str` - The string value to search for.</li>
  <li>`column_name` - Name of a column on which the filter by value would be applied.</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_value.rs#L120-L131)
pub async fn [filter\_by\_value\_raw](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-value.md#method.filter_by_value_raw)( \&self, request: &[FilterByValueRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByValueRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByValueResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByValueResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

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

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

Sends a pre-built [`FilterByValueRequest`](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByValueRequest) 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.