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

◆ filterByGeometry() \[1/2]

FilterByGeometryResponse kinetica.Kinetica.filterByGeometry ( FilterByGeometryRequest request\_ )
inline

Applies a geometry filter against a geospatial geometry column in a given table or view.

The filtering geometry is provided by input\_wkt.

Parameters
request\_ Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 37411 of file KineticaFunctions.cs.

◆ filterByGeometry() \[2/2]

FilterByGeometryResponse kinetica.Kinetica.filterByGeometry ( string table\_name,
string view\_name,
string column\_name,
string input\_wkt,
string operation,
IDictionary\< string, string > options = null )
inline

Applies a geometry filter against a geospatial geometry column in a given table or view.

The filtering geometry is provided by input\_wkt .

Parameters
table\_name Name of the table on which the filter by geometry will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name Name of the column to be used in the filter. Must be a geospatial geometry column.
input\_wkt A geometry in WKT format that will be used to filter the objects in table\_name . The default value is ''.
operation The geometric filtering operation to perform. Supported values:
  • CONTAINS: Matches records that contain the given WKT in input\_wkt , i.e. the given WKT is within the bounds of a record's geometry.
  • CROSSES: Matches records that cross the given WKT.
  • DISJOINT: Matches records that are disjoint from the given WKT.
  • EQUALS: Matches records that are the same as the given WKT.
  • INTERSECTS: Matches records that intersect the given WKT.
  • OVERLAPS: Matches records that overlap the given WKT.
  • TOUCHES: Matches records that touch the given WKT.
  • WITHIN: Matches records that are within the given WKT.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use createSchema 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.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 37567 of file KineticaFunctions.cs.

◆ FilterByGeometryAsync() \[1/2]

async System.Threading.Tasks.Task\< FilterByGeometryResponse > kinetica.Kinetica.FilterByGeometryAsync ( FilterByGeometryRequest request\_,
System.Threading.CancellationToken cancellationToken = default )
inline

Applies a geometry filter against a geospatial geometry column in a given table or view.

(async)

The filtering geometry is provided by input\_wkt.

Parameters
request\_ Request object containing the parameters for the operation.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 37430 of file KineticaFunctions.cs.

◆ FilterByGeometryAsync() \[2/2]

async System.Threading.Tasks.Task\< FilterByGeometryResponse > kinetica.Kinetica.FilterByGeometryAsync ( string table\_name,
string view\_name,
string column\_name,
string input\_wkt,
string operation,
IDictionary\< string, string > options = null,
System.Threading.CancellationToken cancellationToken = default )
inline

Applies a geometry filter against a geospatial geometry column in a given table or view.

(async)

The filtering geometry is provided by input\_wkt .

Parameters
table\_name Name of the table on which the filter by geometry will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view containing a geospatial geometry column.
view\_name If provided, then this will be the name of the view containing the results, in \[schema\_name.]view\_name format, using standard name resolution rules and meeting table naming criteria. Must not be an already existing table or view. The default value is ''.
column\_name Name of the column to be used in the filter. Must be a geospatial geometry column.
input\_wkt A geometry in WKT format that will be used to filter the objects in table\_name . The default value is ''.
operation The geometric filtering operation to perform. Supported values:
  • CONTAINS: Matches records that contain the given WKT in input\_wkt , i.e. the given WKT is within the bounds of a record's geometry.
  • CROSSES: Matches records that cross the given WKT.
  • DISJOINT: Matches records that are disjoint from the given WKT.
  • EQUALS: Matches records that are the same as the given WKT.
  • INTERSECTS: Matches records that intersect the given WKT.
  • OVERLAPS: Matches records that overlap the given WKT.
  • TOUCHES: Matches records that touch the given WKT.
  • WITHIN: Matches records that are within the given WKT.
options Optional parameters.
  • CREATE\_TEMP\_TABLE: If TRUE, a unique temporary table name will be generated in the sys\_temp schema and used in place of view\_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED\_VIEW\_NAME. Supported values: The default value is FALSE.
  • COLLECTION\_NAME: \[DEPRECATED–please specify the containing schema for the view as part of view\_name and use createSchema 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.
The default value is an empty Dictionary.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 37710 of file KineticaFunctions.cs.