> ## 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::FilterRequest

> gpudb::FilterRequest — 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#ad975f31cd9d87d805ebb0513f652eca6">GPUdb::filter</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/filter_8h_source">gpudb/protocol/filter.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:a2547b4d544c9841d5552145c48c08af8" id="r_a2547b4d544c9841d5552145c48c08af8">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2547b4d544c9841d5552145c48c08af8">FilterRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a2547b4d544c9841d5552145c48c08af8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterRequest" title="A set of parameters for GPUdb::filter.">FilterRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a7e701cf75f83c09a8341aa544be18151" id="r_a7e701cf75f83c09a8341aa544be18151">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7e701cf75f83c09a8341aa544be18151">FilterRequest</a> (const std::string \&tableName\_, const std::string \&viewName\_, const std::string \&expression\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:a7e701cf75f83c09a8341aa544be18151">
        <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:aadb10393994e09c0919ca9fd6f55354a" id="r_aadb10393994e09c0919ca9fd6f55354a">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aadb10393994e09c0919ca9fd6f55354a">tableName</a></td>
      </tr>

      <tr className="memdesc:aadb10393994e09c0919ca9fd6f55354a">
        <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:aadb10393994e09c0919ca9fd6f55354a">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a7a88abd6b2c66418fc3224690efbcd11">
        <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:a7a88abd6b2c66418fc3224690efbcd11">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

      <tr className="memdesc:a1251813dfd72839c8f00cf57b39f6c65">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The select expression to filter the specified table. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a27dba09696dea49e4211fc5ea40c4d13">
        <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#ad975f31cd9d87d805ebb0513f652eca6">GPUdb::filter</a>. </p>
      <p>Filters data based on the specified expression. The results are stored in a <a href="/content/concepts/filtered_views/" target="_top">result set</a> with the given <a className="el" href="#a7a88abd6b2c66418fc3224690efbcd11">viewName</a>.</p>
      <p>For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>.</p>
      <p>The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/filter_8h_source">filter.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a2547b4d544c9841d5552145c48c08af8">◆ </a></span>FilterRequest() <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::FilterRequest::FilterRequest </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_1FilterRequest" title="A set of parameters for GPUdb::filter.">FilterRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter_8h_source#l00031">31</a> of file <a className="el" href="/content/api/cpp/filter_8h_source">filter.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a7e701cf75f83c09a8341aa544be18151">◆ </a></span>FilterRequest() <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::FilterRequest::FilterRequest </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::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">expression\_</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_1FilterRequest" title="A set of parameters for GPUdb::filter.">FilterRequest</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">expression\_</td>
                <td>The select expression to filter the specified table. For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>. </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#a1971f80bf1fcdb4621d3b041ef370ba5">filter\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a2a4b400ec6df130a22393344cd0c3320">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#a78930610ce1aebc6008c576a2cc7cc2c">qualified\_view\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2a4b400ec6df130a22393344cd0c3320">filter\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaff79a4ddba623ac0d20db43f399e8f4">filter\_false</a> </li>
                      </ul>

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

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9927509352a13c67d949a7f7b1b84422">filter\_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 is non-existent, it will be automatically created. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a311644db88d1ce29d716715519e4c474">filter\_view\_id</a>: View this filtered-view is part of. The default value is ''. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a92682542e63a9580e5bde8c728398e59">filter\_ttl</a>: Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the view specified in <span className="em arg">viewName\_</span>. </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_8h_source#l00109">109</a> of file <a className="el" href="/content/api/cpp/filter_8h_source">filter.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>The select expression to filter the specified table. </p>
        <p>For details see <a href="/content/concepts/expressions/" target="_top">Expressions</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter_8h_source#l00142">142</a> of file <a className="el" href="/content/api/cpp/filter_8h_source">filter.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a1971f80bf1fcdb4621d3b041ef370ba5">filter\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a2a4b400ec6df130a22393344cd0c3320">true</a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <a className="el" href="#a7a88abd6b2c66418fc3224690efbcd11">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#a78930610ce1aebc6008c576a2cc7cc2c">qualified\_view\_name</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2a4b400ec6df130a22393344cd0c3320">filter\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aaff79a4ddba623ac0d20db43f399e8f4">filter\_false</a> </li>
            </ul>

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

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9927509352a13c67d949a7f7b1b84422">filter\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <a className="el" href="#a7a88abd6b2c66418fc3224690efbcd11">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 is non-existent, it will be automatically created. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a311644db88d1ce29d716715519e4c474">filter\_view\_id</a>: View this filtered-view is part of. The default value is ''. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a92682542e63a9580e5bde8c728398e59">filter\_ttl</a>: Sets the <a href="/content/concepts/ttl/" target="_top">TTL</a> of the view specified in <a className="el" href="#a7a88abd6b2c66418fc3224690efbcd11">viewName</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_8h_source#l00177">177</a> of file <a className="el" href="/content/api/cpp/filter_8h_source">filter.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::FilterRequest::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_8h_source#l00124">124</a> of file <a className="el" href="/content/api/cpp/filter_8h_source">filter.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::FilterRequest::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_8h_source#l00135">135</a> of file <a className="el" href="/content/api/cpp/filter_8h_source">filter.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_8h_source">filter.h</a></li>
    </ul>
  </div>
</div>