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

> gpudb::FilterByRangeRequest — 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#abb55e3a7ca457708686d596cdd5f1d05">GPUdb::filterByRange</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/filter__by__range_8h_source">gpudb/protocol/filter\_by\_range.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:ad49757e307825a8fa028be9426390cca" id="r_ad49757e307825a8fa028be9426390cca">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad49757e307825a8fa028be9426390cca">FilterByRangeRequest</a> ()</td>
      </tr>

      <tr className="memdesc:ad49757e307825a8fa028be9426390cca">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByRangeRequest" title="A set of parameters for GPUdb::filterByRange.">FilterByRangeRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:aaaff90c738bf7574be873aedb151d19a" id="r_aaaff90c738bf7574be873aedb151d19a">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aaaff90c738bf7574be873aedb151d19a">FilterByRangeRequest</a> (const std::string \&tableName\_, const std::string \&viewName\_, const std::string \&columnName\_, const double lowerBound\_, const double upperBound\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

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

      <tr className="memdesc:a669efcf8167a36aef6d8bd5c0199e430">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table on which the filter by range operation will be performed, 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:a669efcf8167a36aef6d8bd5c0199e430">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

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

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

      <tr className="memdesc:a8738b2e3e0970a96c29992fba3745d07">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of a column on which the operation would be applied. <br /></td>
      </tr>

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

      <tr className="memitem:a3ecf2521d8347867930e5d43b4743ef6" id="r_a3ecf2521d8347867930e5d43b4743ef6">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3ecf2521d8347867930e5d43b4743ef6">lowerBound</a></td>
      </tr>

      <tr className="memdesc:a3ecf2521d8347867930e5d43b4743ef6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Value of the lower bound (inclusive). <br /></td>
      </tr>

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

      <tr className="memitem:a8558d271c3649580d12f65e5ff0ee7f1" id="r_a8558d271c3649580d12f65e5ff0ee7f1">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8558d271c3649580d12f65e5ff0ee7f1">upperBound</a></td>
      </tr>

      <tr className="memdesc:a8558d271c3649580d12f65e5ff0ee7f1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Value of the upper bound (inclusive). <br /></td>
      </tr>

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

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

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

      <tr className="separator:a6519c546b807f16567f72018fe648523">
        <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#abb55e3a7ca457708686d596cdd5f1d05">GPUdb::filterByRange</a>. </p>
      <p>Calculates which objects from a table have a column that is within the given bounds. An object from the table identified by <a className="el" href="#a669efcf8167a36aef6d8bd5c0199e430">tableName</a> is added to the view <a className="el" href="#ab088a1e77fb566b1732b9e8696e258a9">viewName</a> if its column is within \[<a className="el" href="#a3ecf2521d8347867930e5d43b4743ef6">lowerBound</a>, <a className="el" href="#a8558d271c3649580d12f65e5ff0ee7f1">upperBound</a>] (inclusive). The operation is synchronous. The response provides a count of the number of objects which passed the bound filter. Although this functionality can also be accomplished with the standard filter function, it is more efficient.</p>
      <p>For track objects, the count reflects how many points fall within the given bounds (which may not include all the track points of any given track). </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__range_8h_source#l00028">28</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ad49757e307825a8fa028be9426390cca">◆ </a></span>FilterByRangeRequest() <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::FilterByRangeRequest::FilterByRangeRequest </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_1FilterByRangeRequest" title="A set of parameters for GPUdb::filterByRange.">FilterByRangeRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__range_8h_source#l00033">33</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aaaff90c738bf7574be873aedb151d19a">◆ </a></span>FilterByRangeRequest() <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::FilterByRangeRequest::FilterByRangeRequest </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">columnName\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const double</td>
                  <td className="paramname"><span className="paramname"><span className="em">lowerBound\_</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">const double</td>
                  <td className="paramname"><span className="paramname"><span className="em">upperBound\_</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_1FilterByRangeRequest" title="A set of parameters for GPUdb::filterByRange.">FilterByRangeRequest</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 on which the filter by range operation will be performed, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. Must be an existing table. </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">columnName\_</td>
                <td>Name of a column on which the operation would be applied. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">lowerBound\_</td>
                <td>Value of the lower bound (inclusive). </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">upperBound\_</td>
                <td>Value of the upper bound (inclusive). </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#aa20bd18ef39d26154308f8866767c01a">filter\_by\_range\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a0a3e23476b8657bdb3286baaf72a4640">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#af0bddfdcae500e3747cd9fa34244a8ab">qualified\_view\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0a3e23476b8657bdb3286baaf72a4640">filter\_by\_range\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad711517efbefcd93e24b0768132b8bc0">filter\_by\_range\_false</a> </li>
                      </ul>

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

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a72e7794cdf95ed6cd92dc21a80537d76">filter\_by\_range\_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>
                  </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__range_8h_source#l00111">111</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of a column on which the operation would be applied. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__range_8h_source#l00143">143</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a3ecf2521d8347867930e5d43b4743ef6">◆ </a></span>lowerBound</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::FilterByRangeRequest::lowerBound</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Value of the lower bound (inclusive). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__range_8h_source#l00148">148</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
      </div>
    </div>

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

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

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

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

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0a3e23476b8657bdb3286baaf72a4640">filter\_by\_range\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad711517efbefcd93e24b0768132b8bc0">filter\_by\_range\_false</a> </li>
            </ul>

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

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a72e7794cdf95ed6cd92dc21a80537d76">filter\_by\_range\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <a className="el" href="#ab088a1e77fb566b1732b9e8696e258a9">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>
        </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__range_8h_source#l00187">187</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the table on which the filter by range operation will be performed, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>Must be an existing table. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__range_8h_source#l00127">127</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8558d271c3649580d12f65e5ff0ee7f1">◆ </a></span>upperBound</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">double gpudb::FilterByRangeRequest::upperBound</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Value of the upper bound (inclusive). </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__range_8h_source#l00153">153</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::FilterByRangeRequest::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__range_8h_source#l00138">138</a> of file <a className="el" href="/content/api/cpp/filter__by__range_8h_source">filter\_by\_range.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__range_8h_source">filter\_by\_range.h</a></li>
    </ul>
  </div>
</div>