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

### filter\_by\_list

<ul>
  <li>
    filter\_by\_list(\
    &#x20;table\_name: string,\
    &#x20;view\_name: string | undefined,\
    &#x20;column\_values\_map: Record\<string, string\[]>,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[FilterByListResponse](https://docs.kinetica.com/content/api/javascript/interfaces/FilterByListResponse.md)>

    Calculates which records from a table have values in the given list for the corresponding column. 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 resultant set (view) which satisfies the input filter specification is also created if a `view_name` is passed in as part of the request.For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map \{"x":\["10.1", "2.3"], "y":\["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

    #### Parameters

    <ul>
      <li>
        table\_name: string

        Name of the table to filter, in \[schema\_name.]table\_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
      </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\_values\_map: Record\<string, string\[]>

        List of values for the corresponding column in the table.
      </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\<[FilterByListResponse](https://docs.kinetica.com/content/api/javascript/interfaces/FilterByListResponse.md)>

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

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

### filter\_by\_list\_request

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

    Calculates which records from a table have values in the given list for the corresponding column. 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 resultant set (view) which satisfies the input filter specification is also created if a `view_name` is passed in as part of the request.For example, if a type definition has the columns 'x' and 'y', then a filter by list query with the column map \{"x":\["10.1", "2.3"], "y":\["0.0", "-31.5", "42.0"]} will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., "x = 10.1 and y = 0.0", "x = 2.3 and y = -31.5", etc. However, a record with "x = 10.1 and y = -31.5" or "x = 2.3 and y = 0.0" would not be returned because the values in the given lists do not correspond.

    #### Parameters

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

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

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


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