Skip to main content

​
◆ filterByGeometry() [1/2]

FilterByGeometryResponse kinetica.Kinetica.filterByGeometry (FilterByGeometryRequestrequest_)
 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 (stringtable_name,
stringview_name,
stringcolumn_name,
stringinput_wkt,
stringoperation,
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_nameName 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_nameIf 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_nameName of the column to be used in the filter. Must be a geospatial geometry column.
input_wktA geometry in WKT format that will be used to filter the objects in table_name . The default value is ”.
operationThe 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.
optionsOptional 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 (FilterByGeometryRequestrequest_,
System.Threading.CancellationTokencancellationToken = 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.
cancellationTokenCancellation 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 (stringtable_name,
stringview_name,
stringcolumn_name,
stringinput_wkt,
stringoperation,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = 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_nameName 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_nameIf 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_nameName of the column to be used in the filter. Must be a geospatial geometry column.
input_wktA geometry in WKT format that will be used to filter the objects in table_name . The default value is ”.
operationThe 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.
optionsOptional 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.
cancellationTokenCancellation 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.