filter_by_area
- filter_by_area(
table_name: string,
view_name: string | undefined,
x_column_name: string,
x_vector: number[],
y_column_name: string,
y_vector: number[],
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<FilterByAreaResponse>Parameters
- table_name: string
Name of the table to filter, in [schema_name.]table_name format, using standard name resolution rules. This may be the name of a table or a view (when chaining queries).
- 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.
- x_column_name: string
Name of the column containing the x values to be filtered.
- x_vector: number[]
List of x coordinates of the vertices of the polygon representing the area to be filtered.
- y_column_name: string
Name of the column containing the y values to be filtered.
- y_vector: number[]
List of y coordinates of the vertices of the polygon representing the area to be filtered.
Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByAreaResponse>
Promise<Types.FilterByAreaResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:8954
- table_name: string
filter_by_area_request
- filter_by_area_request(
request: FilterByAreaRequest,
callback?: GPUdbCallback,
): Promise<FilterByAreaResponse>Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name
view_namepassed in as part of the input.Parameters
- request: FilterByAreaRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByAreaResponse>
Promise<Types.FilterByAreaResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:8915
- request: FilterByAreaRequest
Calculates which objects from a table are within a named area of interest (NAI/polygon). The operation is synchronous, meaning that a response will not be returned until all the matching objects are fully available. The response payload provides the count of the resulting set. A new resultant set (view) which satisfies the input NAI restriction specification is created with the name
view_namepassed in as part of the input.