Replication

Replication is a technique for copying the data from one database to another. Supabase uses replication functionality to provide a real-time API. Replication is useful for:

Spreading out the "load." For example, if your database has a lot of reads, you might want to split it between two databases.
Reducing latency. For example, you may want one database in London to serve your European customers, and one in New York to serve the US.

Replication is done through publications, a method of choosing which changes to send to other systems (usually another Postgres database). Publications can be managed in the Dashboard or with SQL.

Manage publications in the Dashboard#

Go to the Database page in the Dashboard.
Click on Replication in the sidebar.
Control which database events are sent by toggling Insert, Update, and Delete.
Control which tables broadcast changes by selecting Source and toggling each table.

Create a publication#

This publication contains changes to all tables.

create publication publication_name
for all tables;

Create a publication to listen to individual tables#

create publication publication_name
for table table_one, table_two;

Add tables to an existing publication#

alter publication publication_name
add table table_name;

Listen to `insert`#

create publication publication_name
for all tables
with (publish = 'insert');

Listen to `update`#

create publication publication_name
for all tables
with (publish = 'update');

Listen to `delete`#

create publication publication_name
for all tables
with (publish = 'delete');

Remove a publication#

drop publication if exists publication_name;

Recreate a publication#

If you're recreating a publication, it's best to do it in a transaction to ensure the operation succeeds.

begin;
  -- remove the realtime publication
  drop publication if exists publication_name;
  -- re-create the publication but don't enable it for any tables
  create publication publication_name;
commit;

Edit this page on GitHub