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

# FilterByTableRequest

> FilterByTableRequest — Kinetica Node.js API

interface FilterByTableRequest \{\
&#x20;[column\_name](#column_name): string;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[source\_table\_column\_name](#source_table_column_name): string;\
&#x20;[source\_table\_name](#source_table_name): string;\
&#x20;[table\_name](#table_name): string;\
&#x20;[view\_name](#view_name)?: string;\
}

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

##### Index

### Properties

[column\_name](#column_name) [options?](#options) [source\_table\_column\_name](#source_table_column_name) [source\_table\_name](#source_table_name) [table\_name](#table_name) [view\_name?](#view_name)&#x20;

## Properties

### column\_name

column\_name: string

Name of the column by whose value the data will be filtered from the table designated by `table_name`.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### source\_table\_column\_name

source\_table\_column\_name: string

Name of the column in the `source_table_name` whose values will be used as the filter for table `table_name`. Must be a geospatial geometry column if in 'spatial' mode; otherwise, Must match the type of the `column_name`.

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

### source\_table\_name

source\_table\_name: string

Name of the table whose data will be compared against in the table called `table_name`, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.

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

### table\_name

table\_name: string

Name of the table whose data will be filtered, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table.

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


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