filter_by_list
- filter_by_list(
table_name: string,
view_name: string | undefined,
column_values_map: Record<string, string[]>,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<FilterByListResponse>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.
- column_values_map: Record<string, string[]>
List of values for the corresponding column in the table.
Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByListResponse>
Promise<Types.FilterByListResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9344
- table_name: string
filter_by_list_request
- filter_by_list_request(
request: FilterByListRequest,
callback?: GPUdbCallback,
): Promise<FilterByListResponse>Calculates which records from a table have values in the given list for the corresponding column. 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 filter specification is also created if a
view_nameis passed in as part of the request.For example, if a type definition has the columns ‘x’ and ‘y’, then a filter by list query with the column map “x”:[“10.1”, “2.3”], “y”:[“0.0”, “-31.5”, “42.0”] will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., “x = 10.1 and y = 0.0”, “x = 2.3 and y = -31.5”, etc. However, a record with “x = 10.1 and y = -31.5” or “x = 2.3 and y = 0.0” would not be returned because the values in the given lists do not correspond.
Parameters
- request: FilterByListRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<FilterByListResponse>
Promise<Types.FilterByListResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:9304
- request: FilterByListRequest
Calculates which records from a table have values in the given list for the corresponding column. 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 filter specification is also created if a
view_nameis passed in as part of the request.For example, if a type definition has the columns ‘x’ and ‘y’, then a filter by list query with the column map “x”:[“10.1”, “2.3”], “y”:[“0.0”, “-31.5”, “42.0”] will return the count of all data points whose x and y values match both in the respective x- and y-lists, e.g., “x = 10.1 and y = 0.0”, “x = 2.3 and y = -31.5”, etc. However, a record with “x = 10.1 and y = -31.5” or “x = 2.3 and y = 0.0” would not be returned because the values in the given lists do not correspond.