> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="filterByGeometry(com.gpudb.protocol.FilterByGeometryRequest)">
        <h3>filterByGeometry</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryResponse" title="class in com.gpudb.protocol">FilterByGeometryResponse</a></span> <span className="element-name">filterByGeometry</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest" title="class in com.gpudb.protocol">FilterByGeometryRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by <a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest#getInputWkt()"><code>inputWkt</code></a>.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="filterByGeometry(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.Map)">
        <h3>filterByGeometry</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryResponse" title="class in com.gpudb.protocol">FilterByGeometryResponse</a></span> <span className="element-name">filterByGeometry</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> viewName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> columnName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> inputWkt, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> operation, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">Applies a geometry filter against a geospatial geometry column in a given table or view. The filtering geometry is provided by <code> inputWkt</code>.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>tableName</code> - 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.</div>
          <div className="dd"><code>viewName</code> - 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 ''.</div>
          <div className="dd"><code>columnName</code> - Name of the column to be used in the filter. Must be a geospatial geometry column.</div>
          <div className="dd"><code>inputWkt</code> - A geometry in WKT format that will be used to filter the objects in <code>tableName</code>. The default value is ''.</div>

          <div className="dd">
            <code>operation</code> - The geometric filtering operation to perform. Supported values:

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#CONTAINS"><code>CONTAINS</code></a>: Matches records that contain the given WKT in <code>inputWkt</code>, i.e. the given WKT is within the bounds of a record's geometry. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#CROSSES"><code>CROSSES</code></a>: Matches records that cross the given WKT. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#DISJOINT"><code>DISJOINT</code></a>: Matches records that are disjoint from the given WKT. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#EQUALS"><code>EQUALS</code></a>: Matches records that are the same as the given WKT. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#INTERSECTS"><code>INTERSECTS</code></a>: Matches records that intersect the given WKT. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#OVERLAPS"><code>OVERLAPS</code></a>: Matches records that overlap the given WKT. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#TOUCHES"><code>TOUCHES</code></a>: Matches records that touch the given WKT. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Operation#WITHIN"><code>WITHIN</code></a>: Matches records that are within the given WKT. </li>
            </ul>
          </div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Options#CREATE_TEMP_TABLE"><code>CREATE\_TEMP\_TABLE</code></a>: If <a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Options#TRUE"><code>TRUE</code></a>, a unique temporary table name will be generated in the sys\_temp schema and used in place of <code>viewName</code>. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in <a href="/content/api/java/com/gpudb/protocol/FilterByGeometryResponse.Info#QUALIFIED_VIEW_NAME"><code>QUALIFIED\_VIEW\_NAME</code></a>. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>

              <li><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryRequest.Options#COLLECTION_NAME"><code>COLLECTION\_NAME</code></a>: \[DEPRECATED--please specify the containing schema for the view as part of <code>viewName</code> and use <a href="#createSchema(java.lang.String,java.util.Map)"><code>createSchema</code></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 <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/FilterByGeometryResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>