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

# FilterByStringRequest

> FilterByStringRequest — Kinetica JavaScript API

interface FilterByStringRequest \{\
&#x20;[column\_names](#column_names): string\[];\
&#x20;[expression](#expression): string;\
&#x20;[mode](#mode): string;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[table\_name](#table_name): string;\
&#x20;[view\_name](#view_name)?: string;\
}

<ul>
  <li>Defined in [src/types.ts:3010](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3010)</li>
</ul>

##### Index

### Properties

[column\_names](#column_names) [expression](#expression) [mode](#mode) [options?](#options) [table\_name](#table_name) [view\_name?](#view_name)&#x20;

## Properties

### column\_names

column\_names: string\[]

List of columns on which to apply the filter. Ignored for search mode.

<ul>
  <li>Defined in [src/types.ts:3020](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3020)</li>
</ul>

### expression

expression: string

The expression with which to filter the table.

<ul>
  <li>Defined in [src/types.ts:3016](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3016)</li>
</ul>

### mode

mode: string

The string filtering mode to apply. See below for details.

<ul>
  <li>Defined in [src/types.ts:3018](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3018)</li>
</ul>

### `Optional`options

options?: Record\<string, string>

Optional parameters.

<ul>
  <li>Defined in [src/types.ts:3022](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3022)</li>
</ul>

### table\_name

table\_name: string

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.

<ul>
  <li>Defined in [src/types.ts:3012](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3012)</li>
</ul>

### `Optional`view\_name

view\_name?: string

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.

<ul>
  <li>Defined in [src/types.ts:3014](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3014)</li>
</ul>


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