Readyset

Readyset is a SQL caching engine that helps developers build performant, real-time applications without making code changes or switching databases.

Ready to use Readyset?

We're excited to onboard you onto Readyset. Before we can get started, we'll need to make sure your database is configured correctly. Please verify the following list of requirements on Supabase:

Request access to prep_readyset function via support ticket

There are few required queries that need to be run in order to prepare your cluster for Readyset use. A predefined function that will perform all those actions can be requested from the Supabase Support team. Open a support ticket requesting access to prep_readyset function and provide your Reference ID. You can get your Reference ID by navigating to Settings > General:

Once created, you can run select prep_readyset(); from the SQL editor in the Dashboard.

Enable IPv4

Navigate to Settings > Add Ons and click on Change IPv4 Address

Select IPv4 Address and click in Confirm.

Disable Connection Pooling

Navigate to Settings > Database and unselect Use connection pooling:

Grab your connection ID to be used in Readyset Cloud.

Run Readyset with Required Flags

Once everything is set, the only remaining step is running readyset with two additional options. You can either pass the --disable-setup-ddl-replication and --disable-create-publication flags directly to the CLI, or you can set DISABLE_SETUP_DDL_REPLICATION and DISABLE_CREATE_PUBLICATION options if you are using configuration file.