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

# FilterByGeometryRequest

> FilterByGeometryRequest — Kinetica Node.js API

interface FilterByGeometryRequest \{\
&#x20;[column\_name](#column_name): string;\
&#x20;[input\_wkt](#input_wkt)?: string;\
&#x20;[operation](#operation): 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:2866](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/types.ts#L2866)</li>
</ul>

##### Index

### Properties

[column\_name](#column_name) [input\_wkt?](#input_wkt) [operation](#operation) [options?](#options) [table\_name](#table_name) [view\_name?](#view_name)&#x20;

## Properties

### column\_name

column\_name: string

Name of the column to be used in the filter. Must be a geospatial geometry column.

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

### `Optional`input\_wkt

input\_wkt?: string

A geometry in WKT format that will be used to filter the objects in `table_name`.

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

### operation

operation: string

The geometric filtering operation to perform.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### table\_name

table\_name: string

Name of the table on which the filter by geometry will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.

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


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