realtime-kt/io.github.jan.supabase.realtime/PostgresChangeFilter/filter

filter

fun filter(filter: FilterOperation)(source)

Filters the received changes in your table.

Parameters

filter

The filter operation. Note that only some operators are supported. See Postgres Changes for more information.

fun filter(column: String, operator: FilterOperator, value: Any)(source)

Filters the received changes in your table.

Parameters

column

The column name

operator

The filter operator. Note that only some operators are supported. See Postgres Changes for more information.

value

The value to filter for. This can be context dependent. E.g. for the IN operator this can be a list of values, however you can also provide a String.

inline fun filter(builder: RealtimePostgresFilterBuilder.() -> Unit)(source)

fun filter(builder: RealtimePostgresFilterBuilder)(source)

Fluent builder for Postgres Changes filter strings.

Each method appends a single column=operator.value condition. Multiple conditions are combined with commas, which the Realtime server applies as an AND.

The builder mirrors the postgrest-kt filter API (eq, neq, in, like, not, …) for the operators that Realtime supports. Values containing reserved characters (,, (, ), ", \) — or surrounding whitespace — are automatically double-quoted and escaped the same way PostgREST does, so they survive the server's filter parser; all other values are sent verbatim.

var filter: String?(source)

Filter the received changes in your table. E.g.: "user_id=eq.1"