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

# gpudb::FilterByListRequest

> gpudb::FilterByListRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a16572195af55d6e7b2b6f267977998ec">GPUdb::filterByList</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/filter__by__list_8h_source">gpudb/protocol/filter\_by\_list.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a8625dfe060c2c889612f492ca95ef1bf" id="r_a8625dfe060c2c889612f492ca95ef1bf">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8625dfe060c2c889612f492ca95ef1bf">FilterByListRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a8625dfe060c2c889612f492ca95ef1bf">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByListRequest" title="A set of parameters for GPUdb::filterByList.">FilterByListRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a8625dfe060c2c889612f492ca95ef1bf">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a0f1d0ef8c9c0727314249ec0121f0e57" id="r_a0f1d0ef8c9c0727314249ec0121f0e57">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a0f1d0ef8c9c0727314249ec0121f0e57">FilterByListRequest</a> (const std::string \&tableName\_, const std::string \&viewName\_, const std::map\< std::string, std::vector\< std::string > > \&columnValuesMap\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a0f1d0ef8c9c0727314249ec0121f0e57">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByListRequest" title="A set of parameters for GPUdb::filterByList.">FilterByListRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a0f1d0ef8c9c0727314249ec0121f0e57">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:aced4a28ec8a7b2236b046f8f86f4655d" id="r_aced4a28ec8a7b2236b046f8f86f4655d">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aced4a28ec8a7b2236b046f8f86f4655d">tableName</a></td>
      </tr>

      <tr className="memdesc:aced4a28ec8a7b2236b046f8f86f4655d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table to filter, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. <br /></td>
      </tr>

      <tr className="separator:aced4a28ec8a7b2236b046f8f86f4655d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a99d3aaa6bd9b135d4b7c05f28dc2077a" id="r_a99d3aaa6bd9b135d4b7c05f28dc2077a">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a99d3aaa6bd9b135d4b7c05f28dc2077a">viewName</a></td>
      </tr>

      <tr className="memdesc:a99d3aaa6bd9b135d4b7c05f28dc2077a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If provided, then this will be the name of the view containing the results, in \[ schema\_name. ]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. <br /></td>
      </tr>

      <tr className="separator:a99d3aaa6bd9b135d4b7c05f28dc2077a">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a84b6887fc560a5a2423085c5e152c491" id="r_a84b6887fc560a5a2423085c5e152c491">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::vector\< std::string > > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a84b6887fc560a5a2423085c5e152c491">columnValuesMap</a></td>
      </tr>

      <tr className="memdesc:a84b6887fc560a5a2423085c5e152c491">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">List of values for the corresponding column in the table. <br /></td>
      </tr>

      <tr className="separator:a84b6887fc560a5a2423085c5e152c491">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a7b3c5e27fea18843bddb1c6b7397a339" id="r_a7b3c5e27fea18843bddb1c6b7397a339">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7b3c5e27fea18843bddb1c6b7397a339">options</a></td>
      </tr>

      <tr className="memdesc:a7b3c5e27fea18843bddb1c6b7397a339">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:a7b3c5e27fea18843bddb1c6b7397a339">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a16572195af55d6e7b2b6f267977998ec">GPUdb::filterByList</a>. </p>
      <p>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 <a className="el" href="#a99d3aaa6bd9b135d4b7c05f28dc2077a">viewName</a> is passed in as part of the request.</p>
      <p>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. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__list_8h_source#l00031">31</a> of file <a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a8625dfe060c2c889612f492ca95ef1bf">◆ </a></span>FilterByListRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::FilterByListRequest::FilterByListRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByListRequest" title="A set of parameters for GPUdb::filterByList.">FilterByListRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__list_8h_source#l00036">36</a> of file <a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a0f1d0ef8c9c0727314249ec0121f0e57">◆ </a></span>FilterByListRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::FilterByListRequest::FilterByListRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableName\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">viewName\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::vector\< std::string > > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">columnValuesMap\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByListRequest" title="A set of parameters for GPUdb::filterByList.">FilterByListRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">tableName\_</td>
                <td>Name of the table to filter, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. This may be the name of a table or a view (when chaining queries). </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">viewName\_</td>
                <td>If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. Must not be an already existing table or view. The default value is ''. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnValuesMap\_</td>
                <td>List of values for the corresponding column in the table. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a331703b68b6d54274c36694d3d4a6012">filter\_by\_list\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a496dc5055a6a4c6e4a21d62a5d1bf325">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <span className="em arg">viewName\_</span>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cpp/namespacegpudb#a00006e78b0ee84b2fc798cc5ed0df4fa">qualified\_view\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a496dc5055a6a4c6e4a21d62a5d1bf325">filter\_by\_list\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad85b11509308fd3f17c4cb162f838d90">filter\_by\_list\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ad85b11509308fd3f17c4cb162f838d90">filter\_by\_list\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8354d9ff3b7fe5203feb37a50d34d0ac">filter\_by\_list\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <span className="em arg">viewName\_</span> and use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4aa5990ebebfab30b5961654f546cfd0">GPUdb::createSchema</a> to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#adf952c68d6b5c8ad029210bbfaa31ce7">filter\_by\_list\_filter\_mode</a>: String indicating the filter mode, either 'in\_list' or 'not\_in\_list'. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9499e74b3ac23a5d97e7200eea0a9063">filter\_by\_list\_in\_list</a>: The filter will match all items that are in the provided list(s). </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8d53ccbffeb5a28fd7ed28cc10596b6c">filter\_by\_list\_not\_in\_list</a>: The filter will match all items that are not in the provided list(s). </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9499e74b3ac23a5d97e7200eea0a9063">filter\_by\_list\_in\_list</a>.
                    </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__list_8h_source#l00130">130</a> of file <a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a84b6887fc560a5a2423085c5e152c491">◆ </a></span>columnValuesMap</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::vector\<std::string> > gpudb::FilterByListRequest::columnValuesMap</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>List of values for the corresponding column in the table. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__list_8h_source#l00161">161</a> of file <a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a7b3c5e27fea18843bddb1c6b7397a339">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::FilterByListRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a331703b68b6d54274c36694d3d4a6012">filter\_by\_list\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a496dc5055a6a4c6e4a21d62a5d1bf325">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="#a99d3aaa6bd9b135d4b7c05f28dc2077a">viewName</a>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a className="el" href="/content/api/cpp/namespacegpudb#a00006e78b0ee84b2fc798cc5ed0df4fa">qualified\_view\_name</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a496dc5055a6a4c6e4a21d62a5d1bf325">filter\_by\_list\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad85b11509308fd3f17c4cb162f838d90">filter\_by\_list\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#ad85b11509308fd3f17c4cb162f838d90">filter\_by\_list\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8354d9ff3b7fe5203feb37a50d34d0ac">filter\_by\_list\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <a className="el" href="#a99d3aaa6bd9b135d4b7c05f28dc2077a">viewName</a> and use <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4aa5990ebebfab30b5961654f546cfd0">GPUdb::createSchema</a> to create the schema if non-existent] Name of a schema for the newly created view. If the schema provided is non-existent, it will be automatically created. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#adf952c68d6b5c8ad029210bbfaa31ce7">filter\_by\_list\_filter\_mode</a>: String indicating the filter mode, either 'in\_list' or 'not\_in\_list'. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9499e74b3ac23a5d97e7200eea0a9063">filter\_by\_list\_in\_list</a>: The filter will match all items that are in the provided list(s). </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8d53ccbffeb5a28fd7ed28cc10596b6c">filter\_by\_list\_not\_in\_list</a>: The filter will match all items that are not in the provided list(s). </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a9499e74b3ac23a5d97e7200eea0a9063">filter\_by\_list\_in\_list</a>.
          </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__list_8h_source#l00209">209</a> of file <a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aced4a28ec8a7b2236b046f8f86f4655d">◆ </a></span>tableName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::FilterByListRequest::tableName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the table to filter, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>This may be the name of a table or a view (when chaining queries). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__list_8h_source#l00145">145</a> of file <a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a99d3aaa6bd9b135d4b7c05f28dc2077a">◆ </a></span>viewName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::FilterByListRequest::viewName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>If provided, then this will be the name of the view containing the results, in \[ schema\_name. ]view\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. </p>
        <p>Must not be an already existing table or view. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__list_8h_source#l00156">156</a> of file <a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/filter__by__list_8h_source">filter\_by\_list.h</a></li>
    </ul>
  </div>
</div>