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

### filter\_by\_string

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

    Calculates which objects from a table or view match a string expression for the given string columns. Setting case\_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.

    #### Parameters

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

        The expression with which to filter the table.
      </li>

      <li>
        mode: string

        The string filtering mode to apply. See below for details.
      </li>

      <li>
        column\_names: string\[]

        List of columns on which to apply the filter. Ignored for search mode.
      </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\<[FilterByStringResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByStringResponse.md)>

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

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

### filter\_by\_string\_request

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

    Calculates which objects from a table or view match a string expression for the given string columns. Setting case\_sensitive can modify case sensitivity in matching for all modes except search. For search mode details and limitations, see Full Text Search.

    #### Parameters

    <ul>
      <li>
        request: [FilterByStringRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByStringRequest.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\<[FilterByStringResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/FilterByStringResponse.md)>

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

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


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