Skip to main content
Skip to main content
Edit this page

Google Cloud SQL Postgres source setup guide

References

If you use one of the supported providers (in the sidebar), please refer to the specific guide for that provider.

Supported Postgres versions​

Anything on or after Postgres 12

Enable logical replication​

You don't need to follow the below steps if the settings cloudsql. logical_decoding is on and wal_sender_timeout is 0. These settings should mostly be pre-configured if you are migrating from another data replication tool.

  1. Click on Edit button on the Overview page.
  1. Go to Flags and change cloudsql.logical_decoding to on and wal_sender_timeout to 0. These changes will need restarting your Postgres server.

Creating ClickPipes user and granting permissions​

Connect to your Cloud SQL Postgres through the admin user and run the below commands:

  1. Create a Postgres user for exclusively ClickPipes.

    CREATE USER clickpipes_user PASSWORD 'some-password';

  2. Provide read-only access to the schema from which you are replicating tables to the clickpipes_user. Below example shows setting up permissions for the public schema. If you want to grant access to multiple schemas, you can run these three commands for each schema.

    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 access to this user:

    ALTER ROLE clickpipes_user REPLICATION;

  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.

Add ClickPipes IPs to Firewall​

Please follow the below steps to add ClickPipes IPs to your network.

Note

If your are using SSH Tunneling, then you need to add the ClickPipes IPs to the firewall rules of the Jump Server/Bastion.

  1. Go to Connections section
  1. Go to the Networking subsection
  1. Add the public IPs of ClickPipes

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.