Skip to content

chore: update documentation for select feature #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
filipecabaco merged 1 commit into from
May 28, 2026
Merged

chore: update documentation for select feature #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ create table realtime.subscription (
claims jsonb not null,
claims_role regrole not null generated always as (realtime.to_regrole(claims ->> 'role')) stored,
created_at timestamp not null default timezone('utc', now()),
action_filter text NULL DEFAULT '*'::text CHECK (action_filter IN ('*', 'INSERT', 'UPDATE', 'DELETE'))
unique (subscription_id, entity, filters, action_filter)
action_filter text NULL DEFAULT '*'::text CHECK (action_filter IN ('*', 'INSERT', 'UPDATE', 'DELETE')),
selected_columns text[] DEFAULT null,
unique (subscription_id, entity, filters, action_filter, selected_columns)
);
```
where `realtime.user_defined_filter` is
Expand Down Expand Up @@ -62,6 +63,12 @@ insert into realtime.subscription(subscription_id, entity, filters, claims, acti
values ('832bd278-dac7-4bef-96be-e21c8a0023c4', 'public.notes', array[('id', 'eq', '6')], '{"role", "authenticated"}', 'INSERT');
```

To subscribe to `public.notes` and receive only the `id` and `title` columns (plus primary keys, which are always included):
```sql
insert into realtime.subscription(subscription_id, entity, filters, claims, selected_columns)
values ('832bd278-dac7-4bef-96be-e21c8a0023c4', 'public.notes', '{}', '{"role": "authenticated"}', array['id', 'title']);
```


### Reading WAL

Expand Down
Loading