Flutter: Listen to database changes

Returns real-time data from your table as a Stream.

• Realtime is disabled by default for new tables. You can turn it on by managing replication.
• stream() will emit the initial data as well as any further change on the database as Stream<List<Map<String, dynamic>>> by combining Postgrest and Realtime.
• Takes a list of primary key column names that will be used to update and delete the proper records within the SDK.
• 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
  • .gt('column', value) listens to rows where the column is greater than the value
  • .gte('column', value) listens to rows where the column is greater than or equal to the value
  • .lt('column', value) listens to rows where the column is less than the value
  • .lte('column', value) listens to rows where the column is less than or equal to the value
  • .inFilter('column', [val1, val2, val3]) listens to rows where the column is one of the values

Examples

Listen to a table

supabase.from('countries')
  .stream(primaryKey: ['id'])
  .listen((List<Map<String, dynamic>> data) \{
  // Do something awesome with the data
\});

With filter, order and limit

supabase.from('countries')
  .stream(primaryKey: ['id'])
  .eq('id', 120)
  .order('name')
  .limit(10);

With an IN filter

supabase.from('countries')
  .stream(primaryKey: ['id'])
  .inFilter('id', [1, 2, 3])
  .order('name')
  .limit(10);

Using `stream()` with `StreamBuilder`

final supabase = Supabase.instance.client;

class MyWidget extends StatefulWidget \{
  const MyWidget(\{Key? key\}) : super(key: key);

  @override
  State<MyWidget> createState() => _MyWidgetState();
\}

class _MyWidgetState extends State<MyWidget> \{
  // Persist the stream in a local variable to prevent refetching upon rebuilds
  final _stream = supabase.from('countries').stream(primaryKey: ['id']);

  @override
  Widget build(BuildContext context) \{
    return StreamBuilder(
      stream: _stream,
      builder: (context, snapshot) \{
        // Return your widget with the data from the snapshot
      \},
    );
  \}
\}