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

# filterByBox

<div className="kinetica-doxygen">
  <div id="a7ff600263469d50ac759bc5c458448f5" />

  <h2 className="memtitle"><span className="permalink"><a href="#a7ff600263469d50ac759bc5c458448f5">◆ </a></span>filterByBox() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">FilterByBoxResponse</a> gpudb::GPUdb::filterByBox </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxRequest">FilterByBoxRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Calculates how many objects within the given table lie in a rectangular box. </p>
      <p>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="/content/api/cpp/structgpudb_1_1FilterByBoxRequest#a62be88463b11f3ff31fe175a76623cbd">viewName</a> is passed in as part of the input payload.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a30b08ec7f60291ea463b36f40ff6369e" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">FilterByBoxResponse</a> & gpudb::GPUdb::filterByBox </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxRequest">FilterByBoxRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">FilterByBoxResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Calculates how many objects within the given table lie in a rectangular box. </p>
      <p>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="/content/api/cpp/structgpudb_1_1FilterByBoxRequest#a62be88463b11f3ff31fe175a76623cbd">viewName</a> is passed in as part of the input payload.</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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a3bd9f66e3c922c0e6332cd45d7c788dd" />

  <h2 className="memtitle"><span className="permalink"><a href="#a3bd9f66e3c922c0e6332cd45d7c788dd">◆ </a></span>filterByBox() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">FilterByBoxResponse</a> gpudb::GPUdb::filterByBox </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Calculates how many objects within the given table lie in a rectangular box. </p>
      <p>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 <span className="em arg">viewName</span> is passed in as part of the input payload.</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="#a33d9a0a8e738d14b688f9f869f9640ad">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>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a989bf054ca50099e75b1cfe306d9a64b" />

  <h2 className="memtitle"><span className="permalink"><a href="#a989bf054ca50099e75b1cfe306d9a64b">◆ </a></span>filterByBox() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">FilterByBoxResponse</a> & gpudb::GPUdb::filterByBox </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>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">FilterByBoxResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Calculates how many objects within the given table lie in a rectangular box. </p>
      <p>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 <span className="em arg">viewName</span> is passed in as part of the input payload.</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="#a33d9a0a8e738d14b688f9f869f9640ad">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>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1FilterByBoxResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>