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 input parameter view_name is passed in as part of the input payload.
Input Parameter Description
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| table_name | string | Name 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_name | string | 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 | string | Name of the geospatial geometry column to be filtered. | ||||||
| min_x | double | Lower bound for the x-coordinate of the rectangular box. Must be less than or equal to input parameter max_x. | ||||||
| max_x | double | Upper bound for the x-coordinate of the rectangular box. Must be greater than or equal to input parameter min_x. | ||||||
| min_y | double | Lower bound for the y-coordinate of the rectangular box. Must be less than or equal to input parameter max_y. | ||||||
| max_y | double | Upper bound for the y-coordinate of the rectangular box. Must be greater than or equal to input parameter min_y. | ||||||
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
Output Parameter Description
| Name | Type | Description | ||||
|---|---|---|---|---|---|---|
| count | long | The number of records passing the box filter. | ||||
| info | map of string to strings | Additional information. The default value is an empty map ( {} ).
|
