Skip to main content

​
◆ filterByBoxGeometry() [1/2]

FilterByBoxGeometryResponse kinetica.Kinetica.filterByBoxGeometry (FilterByBoxGeometryRequestrequest_)
 inline

Calculates which geospatial geometry objects from a table intersect a rectangular box.

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 view_name is passed in as part of the input payload.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 37175 of file KineticaFunctions.cs.

​
◆ filterByBoxGeometry() [2/2]

FilterByBoxGeometryResponse kinetica.Kinetica.filterByBoxGeometry (stringtable_name,
stringview_name,
stringcolumn_name,
doublemin_x,
doublemax_x,
doublemin_y,
doublemax_y,
IDictionary< string, string >options = null )
 inline

Calculates which geospatial geometry objects from a table intersect a rectangular box.

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 view_name is passed in as part of the input payload.

Parameters
table_nameName of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
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 geospatial geometry column to be filtered.
min_xLower bound for the x-coordinate of the rectangular box. Must be less than or equal to max_x .
max_xUpper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min_x .
min_yLower bound for the y-coordinate of the rectangular box. Must be less than or equal to max_y .
max_yUpper bound for the y-coordinate of the rectangular box. Must be greater than or equal to min_y .
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 37285 of file KineticaFunctions.cs.

​
◆ FilterByBoxGeometryAsync() [1/2]

async System.Threading.Tasks.Task< FilterByBoxGeometryResponse > kinetica.Kinetica.FilterByBoxGeometryAsync (FilterByBoxGeometryRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Calculates which geospatial geometry objects from a table intersect a rectangular box.

(async)

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 view_name is passed in as part of the input payload.

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 37198 of file KineticaFunctions.cs.

​
◆ FilterByBoxGeometryAsync() [2/2]

async System.Threading.Tasks.Task< FilterByBoxGeometryResponse > kinetica.Kinetica.FilterByBoxGeometryAsync (stringtable_name,
stringview_name,
stringcolumn_name,
doublemin_x,
doublemax_x,
doublemin_y,
doublemax_y,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Calculates which geospatial geometry objects from a table intersect a rectangular box.

(async)

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 view_name is passed in as part of the input payload.

Parameters
table_nameName of the table on which the bounding box operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
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 geospatial geometry column to be filtered.
min_xLower bound for the x-coordinate of the rectangular box. Must be less than or equal to max_x .
max_xUpper bound for the x-coordinate of the rectangular box. Must be greater than or equal to min_x .
min_yLower bound for the y-coordinate of the rectangular box. Must be less than or equal to max_y .
max_yUpper bound for the y-coordinate of the rectangular box. Must be greater than or equal to min_y .
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 37381 of file KineticaFunctions.cs.