Prerequisites
To get started, you first need to make sure that your Postgres database is set up correctly. Depending on your source Postgres instance, you may follow any of the following guides:- Amazon RDS Postgres
- Amazon Aurora Postgres
- Supabase Postgres
- Google Cloud SQL Postgres
- Azure Flexible Server for Postgres
- Neon Postgres
- Crunchy Bridge Postgres
- Generic Postgres Source, if you’re using any other Postgres provider or using a self-hosted instance.
- TimescaleDB, if you’re using the TimescaleDB extension on a managed service or self-hosted instance.
Creating your ClickPipe
Make sure you’re logged in to your ClickHouse Cloud account. If you don’t have an account yet, you can sign up here.- In the ClickHouse Cloud console, navigate to your ClickHouse Cloud Service.
- Select the
Data Sourcesbutton on the left-side menu and click on “Set up a ClickPipe”
-
Select the
Postgres CDCtile
Adding your source Postgres database connection
- Fill in the connection details for your source Postgres database which you configured in the prerequisites step.
Before you start adding your connection details make sure that you have whitelisted ClickPipes IP addresses in your firewall rules. You can find the list of ClickPipes IP addresses here.
For more information refer to the source Postgres setup guides linked at the top of this page.
(Optional) Setting up AWS Private Link
You can use AWS Private Link to connect to your source Postgres database if it is hosted on AWS. This is useful if you want to keep your data transfer private. You can follow the setup guide to set up the connection.(Optional) Changing TLS settings
By default, your ClickPipe will be created with TLS enabled and certificate verification. These defaults can be modified upon ClickPipe creation: Or edited at the Connection settings section of your paused ClickPipe Settings tab: Where:Disable TLStoggles TLS for the connection on or off. Turning TLS off means data is sent as plaintext over the network, potentially including secrets and sensitive data.Skip certificate verificationtoggles on or off the verification of the certificate presented by the source database. Take into consideration the security implications of skipping certificate verification.TLS Host(optional, defaults to the source Host) is the hostname the certificate’s CN must match when certificate verification is enabled.Upload CAcan be used to provide a CA used when certificate verification is enabled.
(Optional) Setting up SSH tunneling
You can specify SSH tunneling details if your source Postgres database isn’t publicly accessible.- Enable the “Use SSH Tunnelling” toggle.
- Fill in the SSH connection details.
-
To use Key-based authentication, click on “Revoke and generate key pair” to generate a new key pair and copy the generated public key to your SSH server under
~/.ssh/authorized_keys. - Click on “Verify Connection” to verify the connection.
Make sure to whitelist ClickPipes IP addresses in your firewall rules for the SSH bastion host so that ClickPipes can establish the SSH tunnel.
Configuring the replication settings
- Make sure to select the replication slot from the dropdown list you created in the prerequisites step.
Advanced settings
You can configure the Advanced settings if needed. A brief description of each setting is provided below:- Sync interval: This is the interval at which ClickPipes will poll the source database for changes. This has implication on the destination ClickHouse service, for cost-sensitive users we recommend to keep this at a higher value (over
3600). - Parallel threads for initial load: This is the number of parallel workers that will be used to fetch the initial snapshot. This is useful when you have a large number of tables and you want to control the number of parallel workers used to fetch the initial snapshot. This setting is per-table.
- Pull batch size: The number of rows to fetch in a single batch. This is a best effort setting and may not be respected in all cases.
- Snapshot number of rows per partition: This is the number of rows that will be fetched in each partition during the initial snapshot. This is useful when you have a large number of rows in your tables and you want to control the number of rows fetched in each partition.
- Snapshot number of tables in parallel: This is the number of tables that will be fetched in parallel during the initial snapshot. This is useful when you have a large number of tables and you want to control the number of tables fetched in parallel.
Configuring the tables
- Here you can select the destination database for your ClickPipe. You can either select an existing database or create a new one.
- You can select the tables you want to replicate from the source Postgres database. While selecting the tables, you can also choose to rename the tables in the destination ClickHouse database as well as exclude specific columns.
Review permissions and start the ClickPipe
- Select the “Full access” role from the permissions dropdown and click “Complete Setup”.