Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/filter/byvalue

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/filter/byvalue

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

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

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. The default value is ''.

is_string

boolean

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

value

double

The value to search for. The default value is 0.

value_str

string

The string value to search for. The default value is ''.

column_name

string

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

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

create_temp_table

If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter view_name. This is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_view_name. The default value is false. The supported values are:

true
false

collection_name

[DEPRECATED--please specify the containing schema for the view as part of input parameter view_name and use /create/schema to create the schema if non-existent] Name of a schema for the newly created view. If the schema is non-existent, it will be automatically created.

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'filter_by_value_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /filter/byvalue endpoint:

Name

Type

Description

count

long

The number of records passing the value filter.

info

map of string to strings

Additional information. The default value is an empty map ( {} ).

Possible Parameters (keys)	Parameter Description
qualified_view_name	The fully qualified name of the view (i.e. including the schema)

Empty string in case of an error.