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

# FilterByValueRequest

> FilterByValueRequest — Kinetica Node.js API

interface FilterByValueRequest \{\
&#x20;[column\_name](#column_name): string;\
&#x20;[is\_string](#is_string): boolean;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[table\_name](#table_name): string;\
&#x20;[value](#value)?: number;\
&#x20;[value\_str](#value_str)?: string;\
&#x20;[view\_name](#view_name)?: string;\
}

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

##### Index

### Properties

[column\_name](#column_name) [is\_string](#is_string) [options?](#options) [table\_name](#table_name) [value?](#value) [value\_str?](#value_str) [view\_name?](#view_name)&#x20;

## Properties

### column\_name

column\_name: string

Name of a column on which the filter by value would be applied.

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

### is\_string

is\_string: boolean

Indicates whether the value being searched for is string or numeric.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### table\_name

table\_name: string

Name of an existing table on which to perform the calculation, in \[schema\_name.]table\_name format, using standard name resolution rules.

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

### `Optional`value

value?: number

The value to search for.

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

### `Optional`value\_str

value\_str?: string

The string value to search for.

<ul>
  <li>Defined in [src/types.ts:3070](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3070)</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:3064](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L3064)</li>
</ul>


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