Version:

filter_by_valueΒΆ

GPUdb.filter_by_value( table_name = None, view_name = '', is_string = None,
                       value = 0, value_str = '', column_name = None, options
                       = {} )

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.

Input Parameter Description

Name Type Description
table_name str Name of an existing table on which to perform the calculation.
view_name str If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. Default value is ''.
is_string bool Indicates whether the value being searched for is string or numeric.
value float The value to search for. Default value is 0.
value_str str The string value to search for. Default value is ''.
column_name str Name of a column on which the filter by value would be applied.
options dict of str Optional parameters. Default value is an empty dict ( {} ).

Output Parameter Description

Name Type Description
count long The number of records passing the value filter.