Skip to main content
Skip to main content
Edit this page

PlanetScale for Postgres source setup guide

References

PlanetScale for Postgres is currently in early access.

Supported Postgres versions​

ClickPipes supports Postgres version 12 and later.

Enable logical replication​

  1. To enable replication on your Postgres instance, we need to make sure that the following settings are set:

    wal_level = logical

    To check the same, you can run the following SQL command:

    SHOW wal_level;

    The output should be logical by default. If not, please log into the PlanetScale console and go to Cluster configuration->Parameters and scroll down to Write-ahead log to change it.

Note

Changing this in the PlanetScale console WILL trigger a restart.

  1. Additionally, it is recommended to increase the setting max_slot_wal_keep_size from its default of 4GB. This is also done via the PlanetScale console by going to Cluster configuration->Parameters and then scroll down to Write-ahead log. To help determine the new value, please take a look here.

Creating a user with permissions and publication​

Connect to your PlanetScale Postgres instance using the default postgres.<...> user and run the following commands:

  1. Create a dedicated user for ClickPipes:

    CREATE USER clickpipes_user PASSWORD 'some-password';

  2. Grant schema-level, read-only access to the user you created in the previous step. The following example shows permissions for the public schema. Repeat these commands for each schema containing tables you want to replicate:

    GRANT USAGE ON SCHEMA "public" TO clickpipes_user;
GRANT SELECT ON ALL TABLES IN SCHEMA "public" TO clickpipes_user;
ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT SELECT ON TABLES TO clickpipes_user;

  3. Grant replication privileges to the user:

    GRANT rds_replication TO clickpipes_user;

  4. Create a publication with the tables you want to replicate. We strongly recommend only including the tables you need in the publication to avoid performance overhead.

    Note

    Any table included in the publication must either have a primary key defined or have its replica identity configured to FULL. See the Postgres FAQs for guidance on scoping.

    • To create a publication for specific tables:

      CREATE PUBLICATION clickpipes FOR TABLE table_to_replicate, table_to_replicate2;

    • To create a publication for all tables in a specific schema:

      CREATE PUBLICATION clickpipes FOR TABLES IN SCHEMA "public";

    The clickpipes publication will contain the set of change events generated from the specified tables, and will later be used to ingest the replication stream.

Caveats​

  1. To connect to PlanetScale Postgres, the current branch needs to be appended to the username created above. For example, if the created user was named clickpipes_user, the actual user provided during the ClickPipe creation needs to be clickpipes_user.branch where branch refers to the "id" of the current PlanetScale Postgres branch. To quickly determine this, you can refer to the username of the postgres user you used to create the user earlier, the part after the period would be the branch id.
  2. Do not use the PSBouncer port (currently 6432) for CDC pipes connecting to PlanetScale Postgres, the normal port 5432 must be used. Either port may be used for initial-load only pipes.
  3. Please ensure you're connecting only to the primary instance, connecting to replica instances is currently not supported.

What's next?​

You can now create your ClickPipe and start ingesting data from your Postgres instance into ClickHouse Cloud. Make sure to note down the connection details you used while setting up your Postgres instance as you will need them during the ClickPipe creation process.