filter_by_radius_geometry
- filter_by_radius_geometry(
table_name: string,
view_name: string | undefined,
column_name: string,
x_center: number,
y_center: number,
radius: number,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<FilterByRadiusGeometryResponse>Parameters
- 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 | undefined
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.
- column_name: string
Name of the geospatial geometry column to be filtered.
- x_center: number
Value of the longitude of the center. Must be within [-180.0, 180.0].
- y_center: number
Value of the latitude of the center. Must be within [-90.0, 90.0].
- radius: number
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.
Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByRadiusGeometryResponse>
Promise<Types.FilterByRadiusGeometryResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9506
- table_name: string
filter_by_radius_geometry_request
- filter_by_radius_geometry_request(
request: FilterByRadiusGeometryRequest,
callback?: GPUdbCallback,
): Promise<FilterByRadiusGeometryResponse>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
view_nameis passed in as part of the request.Parameters
- request: FilterByRadiusGeometryRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByRadiusGeometryResponse>
Promise<Types.FilterByRadiusGeometryResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9467
- request: FilterByRadiusGeometryRequest
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
view_nameis passed in as part of the request.