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

### filter\_by\_value

<ul>
  <li>
    filter\_by\_value(\
    &#x20;table\_name: string,\
    &#x20;view\_name: string | undefined,\
    &#x20;is\_string: boolean,\
    &#x20;value: number | undefined,\
    &#x20;value\_str: string | undefined,\
    &#x20;column\_name: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[FilterByValueResponse](https://docs.kinetica.com/content/api/javascript/interfaces/FilterByValueResponse.md)>

    Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

    #### Parameters

    <ul>
      <li>
        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.
      </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>
        is\_string: boolean

        Indicates whether the value being searched for is string or numeric.
      </li>

      <li>
        value: number | undefined

        The value to search for.
      </li>

      <li>
        value\_str: string | undefined

        The string value to search for.
      </li>

      <li>
        column\_name: string

        Name of a column on which the filter by value would be applied.
      </li>

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

        Optional parameters.
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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

### filter\_by\_value\_request

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

    Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. The operation is synchronous, meaning that a response will not be returned until all the objects are fully available. The response payload provides the count of the resulting set. A new result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

    #### Parameters

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

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

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

        Optional callback function
      </li>
    </ul>

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

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

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


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