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

> gpudb::FilterByBoxRequest — 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#a7ff600263469d50ac759bc5c458448f5">GPUdb::filterByBox</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/filter__by__box_8h_source">gpudb/protocol/filter\_by\_box.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:a0ebdc7c577df296d3ef61581990c7df3" id="r_a0ebdc7c577df296d3ef61581990c7df3">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a0ebdc7c577df296d3ef61581990c7df3">FilterByBoxRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a0ebdc7c577df296d3ef61581990c7df3">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxRequest" title="A set of parameters for GPUdb::filterByBox.">FilterByBoxRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a2fbfb8f8a0881df16559e91aac4ce2e1" id="r_a2fbfb8f8a0881df16559e91aac4ce2e1">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2fbfb8f8a0881df16559e91aac4ce2e1">FilterByBoxRequest</a> (const std::string \&tableName\_, const std::string \&viewName\_, const std::string \&xColumnName\_, const double minX\_, const double maxX\_, const std::string \&yColumnName\_, const double minY\_, const double maxY\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

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

      <tr className="memdesc:a7ad15ceba50ea58650c8b7f23921ae1b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table on which the bounding box 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:a7ad15ceba50ea58650c8b7f23921ae1b">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

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

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

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

      <tr className="memdesc:a76ff91a0e6d57f31cee502daa281930a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the column on which to perform the bounding box query. <br /></td>
      </tr>

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

      <tr className="memitem:a9aa6d228ac49da16664c092a45e20825" id="r_a9aa6d228ac49da16664c092a45e20825">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9aa6d228ac49da16664c092a45e20825">minX</a></td>
      </tr>

      <tr className="memdesc:a9aa6d228ac49da16664c092a45e20825">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Lower bound for the column chosen by <a className="el" href="#a76ff91a0e6d57f31cee502daa281930a">xColumnName</a>. <br /></td>
      </tr>

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

      <tr className="memitem:a117dd98411fef011cdc38e19c16bc3f0" id="r_a117dd98411fef011cdc38e19c16bc3f0">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a117dd98411fef011cdc38e19c16bc3f0">maxX</a></td>
      </tr>

      <tr className="memdesc:a117dd98411fef011cdc38e19c16bc3f0">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Upper bound for <a className="el" href="#a76ff91a0e6d57f31cee502daa281930a">xColumnName</a>. <br /></td>
      </tr>

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

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

      <tr className="memdesc:aadb563c4b3967504e15c1f0a14bd7ca4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of a column on which to perform the bounding box query. <br /></td>
      </tr>

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

      <tr className="memitem:a16dc197e9f16ed118deb2205792be25a" id="r_a16dc197e9f16ed118deb2205792be25a">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a16dc197e9f16ed118deb2205792be25a">minY</a></td>
      </tr>

      <tr className="memdesc:a16dc197e9f16ed118deb2205792be25a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Lower bound for <a className="el" href="#aadb563c4b3967504e15c1f0a14bd7ca4">yColumnName</a>. <br /></td>
      </tr>

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

      <tr className="memitem:a7993ab74179a88ded443b451f902df61" id="r_a7993ab74179a88ded443b451f902df61">
        <td className="memItemLeft" align="right" valign="top">double </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7993ab74179a88ded443b451f902df61">maxY</a></td>
      </tr>

      <tr className="memdesc:a7993ab74179a88ded443b451f902df61">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Upper bound for <a className="el" href="#aadb563c4b3967504e15c1f0a14bd7ca4">yColumnName</a>. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a8bdd5a38fccfe1bbc8e3d4dfd62cd967">
        <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#a7ff600263469d50ac759bc5c458448f5">GPUdb::filterByBox</a>. </p>
      <p>Calculates how many objects within the given table lie in a rectangular box. 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 which satisfies the input NAI restriction specification is also created when a <a className="el" href="#a62be88463b11f3ff31fe175a76623cbd">viewName</a> is passed in as part of the input payload. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00023">23</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a0ebdc7c577df296d3ef61581990c7df3">◆ </a></span>FilterByBoxRequest() <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::FilterByBoxRequest::FilterByBoxRequest </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_1FilterByBoxRequest" title="A set of parameters for GPUdb::filterByBox.">FilterByBoxRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00028">28</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

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

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

                  <td />

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

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

                  <td />

                  <td className="paramtype">const double</td>
                  <td className="paramname"><span className="paramname"><span className="em">maxX\_</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">yColumnName\_</span></span>, </td>
                </tr>

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

                  <td />

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

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

                  <td />

                  <td className="paramtype">const double</td>
                  <td className="paramname"><span className="paramname"><span className="em">maxY\_</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_1FilterByBoxRequest" title="A set of parameters for GPUdb::filterByBox.">FilterByBoxRequest</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 bounding box 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">xColumnName\_</td>
                <td>Name of the column on which to perform the bounding box query. Must be a valid numeric column. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">minX\_</td>
                <td>Lower bound for the column chosen by <span className="em arg">xColumnName\_</span>. Must be less than or equal to <span className="em arg">maxX\_</span>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">maxX\_</td>
                <td>Upper bound for <span className="em arg">xColumnName\_</span>. Must be greater than or equal to <span className="em arg">minX\_</span>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">yColumnName\_</td>
                <td>Name of a column on which to perform the bounding box query. Must be a valid numeric column. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">minY\_</td>
                <td>Lower bound for <span className="em arg">yColumnName\_</span>. Must be less than or equal to <span className="em arg">maxY\_</span>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">maxY\_</td>
                <td>Upper bound for <span className="em arg">yColumnName\_</span>. Must be greater than or equal to <span className="em arg">minY\_</span>. </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#ae595d73aad1d655a91b33106d3f75d74">filter\_by\_box\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a63e4b3d687604e8a03429bbc4bfcfe60">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#a482f294702a8be3134d7f42bae29e641">qualified\_view\_name</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63e4b3d687604e8a03429bbc4bfcfe60">filter\_by\_box\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a301b3dfa60b64268b35fbd415e5943a7">filter\_by\_box\_false</a> </li>
                      </ul>

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

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3aa1e81a8a2a8d3e0186a915f0d6aec9">filter\_by\_box\_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__box_8h_source#l00117">117</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Upper bound for <a className="el" href="#a76ff91a0e6d57f31cee502daa281930a">xColumnName</a>. </p>
        <p>Must be greater than or equal to <a className="el" href="#a9aa6d228ac49da16664c092a45e20825">minX</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00165">165</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a7993ab74179a88ded443b451f902df61">◆ </a></span>maxY</h2>

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

      <div className="memdoc">
        <p>Upper bound for <a className="el" href="#aadb563c4b3967504e15c1f0a14bd7ca4">yColumnName</a>. </p>
        <p>Must be greater than or equal to <a className="el" href="#a16dc197e9f16ed118deb2205792be25a">minY</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00183">183</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a9aa6d228ac49da16664c092a45e20825">◆ </a></span>minX</h2>

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

      <div className="memdoc">
        <p>Lower bound for the column chosen by <a className="el" href="#a76ff91a0e6d57f31cee502daa281930a">xColumnName</a>. </p>
        <p>Must be less than or equal to <a className="el" href="#a117dd98411fef011cdc38e19c16bc3f0">maxX</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00159">159</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a16dc197e9f16ed118deb2205792be25a">◆ </a></span>minY</h2>

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

      <div className="memdoc">
        <p>Lower bound for <a className="el" href="#aadb563c4b3967504e15c1f0a14bd7ca4">yColumnName</a>. </p>
        <p>Must be less than or equal to <a className="el" href="#a7993ab74179a88ded443b451f902df61">maxY</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00177">177</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

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

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

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

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

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63e4b3d687604e8a03429bbc4bfcfe60">filter\_by\_box\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a301b3dfa60b64268b35fbd415e5943a7">filter\_by\_box\_false</a> </li>
            </ul>

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

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3aa1e81a8a2a8d3e0186a915f0d6aec9">filter\_by\_box\_collection\_name</a>: \[DEPRECATED–please specify the containing schema for the view as part of <a className="el" href="#a62be88463b11f3ff31fe175a76623cbd">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__box_8h_source#l00216">216</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the table on which the bounding box 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__box_8h_source#l00136">136</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::FilterByBoxRequest::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__box_8h_source#l00147">147</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a76ff91a0e6d57f31cee502daa281930a">◆ </a></span>xColumnName</h2>

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

      <div className="memdoc">
        <p>Name of the column on which to perform the bounding box query. </p>
        <p>Must be a valid numeric column. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00153">153</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aadb563c4b3967504e15c1f0a14bd7ca4">◆ </a></span>yColumnName</h2>

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

      <div className="memdoc">
        <p>Name of a column on which to perform the bounding box query. </p>
        <p>Must be a valid numeric column. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/filter__by__box_8h_source#l00171">171</a> of file <a className="el" href="/content/api/cpp/filter__by__box_8h_source">filter\_by\_box.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__box_8h_source">filter\_by\_box.h</a></li>
    </ul>
  </div>
</div>