Calculates which objects from a table lie within 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.For track data, all track points that lie within the circle plus one point on
either side of the circle (if the track goes beyond the circle) will be
included in the result.
Input Parameter Description
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.
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 ”.
string
Name of the column to be used for the x-coordinate (the longitude) of the 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.
string
Name of the column to be used for the y-coordinate-the latitude-of the 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.
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.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter 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.The default value is false.The supported values are:
true
false
[DEPRECATED—please specify the containing schema for the view as part of input parameter view_name and use /create/schema to create the schema if non-existent] Name of a schema which is to contain the newly created view. If the schema is non-existent, it will be automatically created.
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘filter_by_radius_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /filter/byradius endpoint:
Show data_str
long
The number of records passing the radius filter.
map of string to strings
Additional information.The default value is an empty map ( {} ).
Show info
The fully qualified name of the view (i.e. including the schema).
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.