filter - Kinetica Docs

filter

filter(
table_name: string,
view_name: string | undefined,
expression: string,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<FilterResponse>
Filters data based on the specified expression. The results are stored in a result set with the given view_name.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
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.
- expression: string
  The select expression to filter the specified table. For details see Expressions.
- Optionaloptions: Record<string, string>
  Optional parameters.
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<FilterResponse>
Promise<Types.FilterResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:8882

filter_request

filter_request(
request: FilterRequest,
callback?: GPUdbCallback,
): Promise<FilterResponse>
Filters data based on the specified expression. The results are stored in a result set with the given view_name.
For details see Expressions.
The response message contains the number of points for which the expression evaluated to be true, which is equivalent to the size of the result view.
Parameters
- request: FilterRequest
  Request object containing the parameters for the operation
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<FilterResponse>
Promise<Types.FilterResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:8848