From a4e4bb491ade306a7a50cb060d8223a197eff7c0 Mon Sep 17 00:00:00 2001 From: dshukertjr <18113850+dshukertjr@users.noreply.github.com> Date: Thu, 25 May 2023 13:44:05 +0900 Subject: [PATCH] docs: update flutter realtime reference docs --- spec/supabase_dart_v1.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/spec/supabase_dart_v1.yml b/spec/supabase_dart_v1.yml index 6f5135ce297..afa95f245e0 100644 --- a/spec/supabase_dart_v1.yml +++ b/spec/supabase_dart_v1.yml @@ -752,7 +752,7 @@ functions: Subscribe to realtime changes in your database. title: 'on().subscribe()' notes: | - - Realtime is disabled by default for new Projects for better database performance and security. You can turn it on by [managing replication](/docs/guides/database/api#managing-realtime). + - Realtime is disabled by default for new tables. You can turn it on by [managing replication](/docs/guides/realtime/extensions/postgres-changes#replication-setup). - If you want to receive the "previous" data for updates and deletes, you will need to set `REPLICA IDENTITY` to `FULL`, like this: `ALTER TABLE your_table REPLICA IDENTITY FULL;` examples: - id: listen-to-all-database-changes @@ -907,11 +907,12 @@ functions: - id: stream description: | - Notifies of data at the queried table. + Returns real-time data from your table as a `Stream`. title: 'stream()' notes: | - - `stream()` will emit the initial data as well as any further change on the database as `Stream` of `List>` by combining Postgrest and Realtime. - - Takes a list of primary key columns as its argument. + - Realtime is disabled by default for new tables. You can turn it on by [managing replication](/docs/guides/realtime/extensions/postgres-changes#replication-setup). + - `stream()` will emit the initial data as well as any further change on the database as `Stream>>` by combining Postgrest and Realtime. + - Takes a list of primary key columns as its argument to be used to update and deleting the proper record internally. - The following filters are available - `.eq('column', value)` listens to rows where the column equals the value - `.neq('column', value)` listens to rows where the column does not equal the value