Skip to main content
  • Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

    Parameters

    • table_name: string

      Name of an existing table on which to perform the calculation, in [schema_name.]table_name format, using standard name resolution rules.

    • 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.

    • is_string: boolean

      Indicates whether the value being searched for is string or numeric.

    • value: number | undefined

      The value to search for.

    • value_str: string | undefined

      The string value to search for.

    • column_name: string

      Name of a column on which the filter by value would be applied.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    Returns Promise<FilterByValueResponse>

    Promise<Types.FilterByValueResponse> - Promise resolving to the response

  • Calculates which objects from a table has a particular value for a particular column. The input parameters provide a way to specify either a String or a Double valued column and a desired value for the column on which the filter is performed. 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 result view which satisfies the input filter restriction specification is also created with a view name passed in as part of the input payload. Although this functionality can also be accomplished with the standard filter function, it is more efficient.

    Parameters

    Returns Promise<FilterByValueResponse>

    Promise<Types.FilterByValueResponse> - Promise resolving to the response