Version:

FilterΒΆ

Filters data based on the specified expression. The results are stored in a result set with the given input parameter 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.

Input Parameter Description

Name Type Description
table_name string Name of the table to filter. This may be the ID of a collection, table or a result set (for chaining queries). Collections may be filtered only if all tables within the collection have the same type ID.
view_name string If provided, then this will be the name of the view containing the results. Has the same naming restrictions as tables. Default value is ''.
expression string The select expression to filter the specified table. For details see Expressions.
options map of string to strings

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

Supported Parameters (keys) Parameter Description
collection_name Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created view will be top-level.
ttl Sets the TTL of the view specified in input parameter view_name.

Output Parameter Description

Name Type Description
count long The number of records that matched the given select expression.