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

# filterByGeometry

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

  <h2 className="memtitle"><span className="permalink"><a href="#a1bebed28c75d07732fb9ad15f64c58ff">◆ </a></span>filterByGeometry() <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_1FilterByGeometryResponse">FilterByGeometryResponse</a> gpudb::GPUdb::filterByGeometry </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByGeometryRequest">FilterByGeometryRequest</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>Applies a geometry filter against a geospatial geometry column in a given table or view. </p>
      <p>The filtering geometry is provided by <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByGeometryRequest#ac5b2052fb73c01f70a130844001a0f26">inputWkt</a>.</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_1FilterByGeometryRequest">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_1FilterByGeometryResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a323acd0004c11a55be16b40ab91818ba" />

  <h2 className="memtitle"><span className="permalink"><a href="#a323acd0004c11a55be16b40ab91818ba">◆ </a></span>filterByGeometry() <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_1FilterByGeometryResponse">FilterByGeometryResponse</a> & gpudb::GPUdb::filterByGeometry </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByGeometryRequest">FilterByGeometryRequest</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_1FilterByGeometryResponse">FilterByGeometryResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Applies a geometry filter against a geospatial geometry column in a given table or view. </p>
      <p>The filtering geometry is provided by <a className="el" href="/content/api/cpp/structgpudb_1_1FilterByGeometryRequest#ac5b2052fb73c01f70a130844001a0f26">inputWkt</a>.</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_1FilterByGeometryRequest">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_1FilterByGeometryResponse">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_1FilterByGeometryResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a922116bd986d005f07507a265332b9eb" />

  <h2 className="memtitle"><span className="permalink"><a href="#a922116bd986d005f07507a265332b9eb">◆ </a></span>filterByGeometry() <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_1FilterByGeometryResponse">FilterByGeometryResponse</a> gpudb::GPUdb::filterByGeometry </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 std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">inputWkt</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">operation</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>Applies a geometry filter against a geospatial geometry column in a given table or view. </p>
      <p>The filtering geometry is provided by <span className="em arg">inputWkt</span>.</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 geometry 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 or view containing a geospatial geometry column. </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 the column to be used in the filter. Must be a geospatial geometry column. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">inputWkt</td>
              <td>A geometry in WKT format that will be used to filter the objects in <span className="em arg">tableName</span>. The default value is ''. </td>
            </tr>

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

              <td>
                The geometric filtering operation to perform. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a18e75efa3105b3114b5c1b9c2224528b">filter\_by\_geometry\_contains</a>: Matches records that contain the given WKT in <span className="em arg">inputWkt</span>, i.e. the given WKT is within the bounds of a record's geometry. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae5410af2df2a4359ea7dfc6ed0d3736c">filter\_by\_geometry\_crosses</a>: Matches records that cross the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a87414b24a199a8fa5ac7d0ccc57033bb">filter\_by\_geometry\_disjoint</a>: Matches records that are disjoint from the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#acacd71c688c482644014669610e042c3">filter\_by\_geometry\_equals</a>: Matches records that are the same as the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a254198784ee441bb1d3b45ff09bb95cc">filter\_by\_geometry\_intersects</a>: Matches records that intersect the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a345259ee649acdc91f1313ef42201a8a">filter\_by\_geometry\_overlaps</a>: Matches records that overlap the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3c945c89b5659cf94c8b0a103eff19e1">filter\_by\_geometry\_touches</a>: Matches records that touch the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#abb1a55908096c5b6022e015d15ed33bc">filter\_by\_geometry\_within</a>: Matches records that are within the given WKT. </li>
                </ul>
              </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#a430928cbcd28d8d3a637fa75fa015e2c">filter\_by\_geometry\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad7b3f4f8483d75ee765eb47f5c3b6e8d">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#a40240a9667fc9afc3e67d97cf0304d12">qualified\_view\_name</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad7b3f4f8483d75ee765eb47f5c3b6e8d">filter\_by\_geometry\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7f1cefd18f30094ac2f8e99e3f0bfca3">filter\_by\_geometry\_false</a> </li>
                    </ul>

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

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac38f8500129dfc84e3e0e1607c3b9ef5">filter\_by\_geometry\_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 provided 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_1FilterByGeometryResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a77c2a9d3b73e4bd4966bf2fe5e85e1cc" />

  <h2 className="memtitle"><span className="permalink"><a href="#a77c2a9d3b73e4bd4966bf2fe5e85e1cc">◆ </a></span>filterByGeometry() <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_1FilterByGeometryResponse">FilterByGeometryResponse</a> & gpudb::GPUdb::filterByGeometry </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 std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">inputWkt</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">operation</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_1FilterByGeometryResponse">FilterByGeometryResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Applies a geometry filter against a geospatial geometry column in a given table or view. </p>
      <p>The filtering geometry is provided by <span className="em arg">inputWkt</span>.</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 geometry 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 or view containing a geospatial geometry column. </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 the column to be used in the filter. Must be a geospatial geometry column. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">inputWkt</td>
              <td>A geometry in WKT format that will be used to filter the objects in <span className="em arg">tableName</span>. The default value is ''. </td>
            </tr>

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

              <td>
                The geometric filtering operation to perform. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a18e75efa3105b3114b5c1b9c2224528b">filter\_by\_geometry\_contains</a>: Matches records that contain the given WKT in <span className="em arg">inputWkt</span>, i.e. the given WKT is within the bounds of a record's geometry. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae5410af2df2a4359ea7dfc6ed0d3736c">filter\_by\_geometry\_crosses</a>: Matches records that cross the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a87414b24a199a8fa5ac7d0ccc57033bb">filter\_by\_geometry\_disjoint</a>: Matches records that are disjoint from the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#acacd71c688c482644014669610e042c3">filter\_by\_geometry\_equals</a>: Matches records that are the same as the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a254198784ee441bb1d3b45ff09bb95cc">filter\_by\_geometry\_intersects</a>: Matches records that intersect the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a345259ee649acdc91f1313ef42201a8a">filter\_by\_geometry\_overlaps</a>: Matches records that overlap the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3c945c89b5659cf94c8b0a103eff19e1">filter\_by\_geometry\_touches</a>: Matches records that touch the given WKT. </li>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#abb1a55908096c5b6022e015d15ed33bc">filter\_by\_geometry\_within</a>: Matches records that are within the given WKT. </li>
                </ul>
              </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#a430928cbcd28d8d3a637fa75fa015e2c">filter\_by\_geometry\_create\_temp\_table</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#ad7b3f4f8483d75ee765eb47f5c3b6e8d">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#a40240a9667fc9afc3e67d97cf0304d12">qualified\_view\_name</a>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad7b3f4f8483d75ee765eb47f5c3b6e8d">filter\_by\_geometry\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7f1cefd18f30094ac2f8e99e3f0bfca3">filter\_by\_geometry\_false</a> </li>
                    </ul>

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

                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac38f8500129dfc84e3e0e1607c3b9ef5">filter\_by\_geometry\_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 provided 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_1FilterByGeometryResponse">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_1FilterByGeometryResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>