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

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_string.rs#L32-L49)
pub async fn [filter\_by\_string](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-string.md#method.filter_by_string)( \&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), expression: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), mode: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), column\_names: [Vec](https://doc.rust-lang.org/1.98.1/alloc/vec/struct.Vec.html)\<[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)\<[FilterByStringResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByStringResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Filter a dataset for records with matching column text valuesCalculates which objects from a table or view match a string expression for the given string columns. Setting case\_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.

##### Arguments

<ul>
  <li>`table_name` - Name of the table on which the filter operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view.</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>`expression` - The expression with which to filter the table.</li>
  <li>`mode` - The string filtering mode to apply. See below for details.</li>
  <li>`column_names` - List of columns on which to apply the filter. Ignored for search mode.</li>
</ul>

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_string.rs#L73-L97)
pub async fn [filter\_by\_string\_with\_opts](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-string.md#method.filter_by_string_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), expression: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), mode: [String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html), column\_names: [Vec](https://doc.rust-lang.org/1.98.1/alloc/vec/struct.Vec.html)\<[String](https://doc.rust-lang.org/1.98.1/alloc/string/struct.String.html)>, options: [FilterByStringRequestOptions](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByStringRequestOptions.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByStringResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByStringResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

Filter a dataset for records with matching column text valuesCalculates which objects from a table or view match a string expression for the given string columns. Setting case\_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.

##### Arguments

<ul>
  <li>`table_name` - Name of the table on which the filter operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view.</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>`expression` - The expression with which to filter the table.</li>
  <li>`mode` - The string filtering mode to apply. See below for details.</li>
  <li>`column_names` - List of columns on which to apply the filter. Ignored for search mode.</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_string.rs#L100-L111)
pub async fn [filter\_by\_string\_raw](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-string.md#method.filter_by_string_raw)( \&self, request: &[FilterByStringRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByStringRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByStringResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByStringResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

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

[Source](https://github.com/kineticadb/kinetica-api-rust/blob/master/crates/gpudb-api/src/generated/filter_by_string.rs#L115-L127)
pub async fn [filter\_by\_string\_from\_url](https://docs.kinetica.com/content/api/rust/gpudb/struct.Kinetica/filter-by-string.md#method.filter_by_string_from_url)( \&self, url: &[str](https://doc.rust-lang.org/1.98.1/std/primitive.str.html), request: &[FilterByStringRequest](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByStringRequest.md), ) -> [Result](https://doc.rust-lang.org/1.98.1/core/result/enum.Result.html)\<[FilterByStringResponse](https://docs.kinetica.com/content/api/rust/generated/api/struct.FilterByStringResponse.md), [KineticaError](https://docs.kinetica.com/content/api/rust/errors/enum.KineticaError.md)>

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