Calculates which geospatial geometry objects from a table intersect a circle with the given radius and center point (i.e. circular NAI). 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 (view) which satisfies the input circular NAI restriction specification is also created if a input parameter view_name is passed in as part of the request.
Input Parameter Description
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
| table_name | string | Name of the table on which the filter by radius 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. | ||||||
| x_center | double | Value of the longitude of the center. Must be within [-180.0, 180.0]. The minimum allowed value is -180. The maximum allowed value is 180. | ||||||
| y_center | double | Value of the latitude of the center. Must be within [-90.0, 90.0]. The minimum allowed value is -90. The maximum allowed value is 90. | ||||||
| radius | double | The radius of the circle within which the search will be performed. Must be a non-zero positive value. It is in meters; so, for example, a value of '42000' means 42 km. The minimum allowed value is 0. The maximum allowed value is MAX_INT. | ||||||
| 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 radius filter. | ||||
| info | map of string to strings | Additional information. The default value is an empty map ( {} ).
|
