filter

DefinitionCopy Anchor Link

Get a subset of rows from table that match one or more condition.

Syntax

filter(table, condition, condition, ...)

filter(orders, orders.status == 'refunded') //-> Table(orders.id, orders.status, ...)
filter(orders, orders.is_cancelled) // -> Table(orders.id, orders.status, ...)

// with pipe
orders | filter(orders.status == 'refunded') //-> Table(orders.id, orders.status, ...)
orders
| select(orders.id, orders.status)
| filter(orders.status == 'refunded') //-> Table(orders.id, orders.status)

// multiple conditions
orders
| filter(orders.status == 'refunded', orders.is_cancelled)
| select(orders.id) //-> Table(orders.id)

Input

• table: A model reference or the returned table from a previous expression.

• condition (repeatable): A formula returning a truefalse value. Each condition is evaluated over each row of table:

  • If the condition evaluates to true, the row is included in the output table.
  • If the condition evaluates to false, the row is excluded from the output table.

  Note: If multiple condition are provided, they are evaluated as a logical AND. For example, filter(orders, orders.status == refunded', orders.is_cancelled) is equivalent to filter(orders, and(orders.status == refunded', orders.is_cancelled)).

Output

A new table that contains all rows in table that match the condition.

Sample UsagesCopy Anchor Link

orders 
| filter(countries.name == "Vietnam", orders.created_at matches @2022-08)
| select(orders.id, orders.user_id)

Any expression that can be used in select column, can be used in filter condition.

orders | group(orders.status) | filter(count(orders.id) > 1000)
// is equivalent to 
// orders 
// | group(orders.status) 
// | select(orders.status, condition: count(orders.id) > 1000)
// | filter(condition)

See alsoCopy Anchor Link

• where(): applies on metrics, not tables
• select()
• group()
• where vs filter
• Pipe operator