filter_by_box
- filter_by_box(
table_name: string,
view_name: string | undefined,
x_column_name: string,
min_x: number,
max_x: number,
y_column_name: string,
min_y: number,
max_y: number,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<FilterByBoxResponse>Parameters
- 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 | 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 on which to perform the bounding box query. Must be a valid numeric column.
- min_x: number
Lower bound for the column chosen by
x_column_name. Must be less than or equal tomax_x. - max_x: number
Upper bound for
x_column_name. Must be greater than or equal tomin_x. - y_column_name: string
Name of a column on which to perform the bounding box query. Must be a valid numeric column.
- min_y: number
Lower bound for
y_column_name. Must be less than or equal tomax_y. - max_y: number
Upper bound for
y_column_name. Must be greater than or equal tomin_y. Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByBoxResponse>
Promise<Types.FilterByBoxResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9108
- table_name: string
filter_by_box_request
- filter_by_box_request(
request: FilterByBoxRequest,
callback?: GPUdbCallback,
): Promise<FilterByBoxResponse>Calculates how many objects within the given table lie in 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
view_nameis passed in as part of the input payload.Parameters
- request: FilterByBoxRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByBoxResponse>
Promise<Types.FilterByBoxResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9066
- request: FilterByBoxRequest
Calculates how many objects within the given table lie in 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
view_nameis passed in as part of the input payload.