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

### filter\_by\_geometry

<ul>
  <li>
    filter\_by\_geometry(\
    &#x20;table\_name: string,\
    &#x20;view\_name: string | undefined,\
    &#x20;column\_name: string,\
    &#x20;input\_wkt: string | undefined,\
    &#x20;operation: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[FilterByGeometryResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByGeometryResponse.md)>

    Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by `input_wkt`.

    #### Parameters

    <ul>
      <li>
        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.
      </li>

      <li>
        view\_name: string | undefined

        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>
        column\_name: string

        Name of the column to be used in the filter. Must be a geospatial geometry column.
      </li>

      <li>
        input\_wkt: string | undefined

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

      <li>
        operation: string

        The geometric filtering operation to perform.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[FilterByGeometryResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByGeometryResponse.md)>

    Promise\<Types.FilterByGeometryResponse> - Promise resolving to the response

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

### filter\_by\_geometry\_request

<ul>
  <li>
    filter\_by\_geometry\_request(\
    &#x20;request: [FilterByGeometryRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByGeometryRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[FilterByGeometryResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByGeometryResponse.md)>

    Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by `input_wkt`.

    #### Parameters

    <ul>
      <li>
        request: [FilterByGeometryRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByGeometryRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[FilterByGeometryResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByGeometryResponse.md)>

    Promise\<Types.FilterByGeometryResponse> - Promise resolving to the response

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


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