Prerequisites

• IP address or host name of your PostgreSQL server is available.

• The PostgreSQL version is 9.4 or higher.

• Log-based incremental replication is enabled if the ingestion mode is Logical Replication:

  Note: PostgreSQL versions 15.7 and below do not support logical replication on read replicas. This feature is available starting from version 16.

• Hevo’s IP addresses are whitelisted.

• SELECT, USAGE, and CONNECT privileges are granted to the database user.

• You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.

Perform the following steps to configure your Google Cloud PostgreSQL Source:

Step 1

Set up Log-based Incremental Replication (Optional)

Step 2

Whitelist Hevo’s IP Addresses

You need to whitelist the Hevo IP addresses for your region to enable Hevo to connect to your PostgreSQL database. To do this:

1. Log in to the Google Cloud SQL Console and click on your PostgreSQL instance ID.

   

2. In the left navigation pane of the <PostgreSQL Instance ID> page, click Connections.

3. In the Connections pane, click the NETWORKING tab, and scroll down to the Authorized networks section.

   

4. Click ADD A NETWORK, and in New Network, specify the following:

   

   • Name: A name to describe the region for Hevo’s IP address.

   • Network: The IP address(es) of your Hevo region in CIDR notation.

5. Click DONE, and then, repeat the step above for all the network addresses you want to add.

6. Click Save.

   

You can view the networks that you have authorized in the Summary tab under Security.

Step 3

Create a Replication User and Grant Privileges

While using logical replication in Google Cloud PostgreSQL, the user must have the cloudsqlsuperuser role. This role is needed to run the CREATE EXTENSION command.

Create a PostgreSQL user with REPLICATION privileges as follows:

1. Connect to your PostgreSQL database instance as a super admin using any SQL client, such as DataGrip, and run the following commands:

    CREATE USER <database_username> WITH REPLICATION
    IN ROLE cloudsqlsuperuser LOGIN PASSWORD 'password';
   

   Alternatively, set this attribute for an existing user as follows:

    ALTER USER <existing_user> WITH REPLICATION;
   

2. Run the following commands to grant privileges to the database user:

    GRANT CONNECT ON DATABASE <database_name> TO <database_username>;
    GRANT USAGE ON SCHEMA <schema_name> TO <database_username>;
    GRANT SELECT ON ALL TABLES IN SCHEMA <schema_name> TO <database_username>;
   

3. Alter the schema’s default privileges to grant SELECT privileges on tables created in the future to the database user:

    ALTER DEFAULT PRIVILEGES IN SCHEMA <schema_name> GRANT SELECT ON TABLES TO <database_username>;
   

Note: Replace the placeholder values in the commands above with your own. For example, <database_username> with hevouser.

Step 4

Specify Google Cloud PostgreSQL Connection Settings

Perform the following steps to configure Google Cloud PostgreSQL as a Source in Hevo:

1. Click PIPELINES in the Navigation Bar.

2. Click + CREATE PIPELINE in the Pipelines List View.

3. In the Select Source Type page, select Google Cloud PostgreSQL.

4. In the Configure your Google Cloud PostgreSQL Source page, specify the following:

   

   • Pipeline Name: A unique name for your Pipeline, not exceeding 255 characters.

   • Database Host: The Google Cloud PostgreSQL host’s IP address or DNS. For example, 35.220.150.0.

   • Database Port: The port on which your Google Cloud PostgreSQL server listens for connections. Default value: 5432.

   • Database User: The read-only user who has the permission to read tables in your database.

   • Database Password: The password for the read-only user.

   • Select an Ingestion Mode: The desired mode by which you want to ingest data from the Source. This section is expanded by default. However, you can collapse the section by clicking SEE LESS. Default value: Logical Replication.

     The available ingestion modes are Logical Replication, Table, and Custom SQL. Additionally, the XMIN ingestion mode is available for Early Access. Logical Replication is the recommended ingestion mode and is selected by default.

     

     Depending on the ingestion mode you select, you must configure the objects to be replicated. Refer to section, Object and Query Mode Settings for the steps to do this.

     Note: For the Custom SQL ingestion mode, all Events loaded to the Destination are billable.

   • Database Name: The name of an existing database that you wish to replicate.

   • Schema Name (Optional): The schema in your database that holds the tables to be replicated. Default value: public.

     Note: The Schema Name field is displayed only for Table and Custom SQL ingestion modes.

   • Connection Settings:

     • Connect through SSH: Enable this option to connect to Hevo using an SSH tunnel, instead of directly connecting your PostgreSQL database host to Hevo. This provides an additional level of security to your database by not exposing your PostgreSQL setup to the public. Read Connecting Through SSH.

       If this option is turned off, you must whitelist Hevo’s IP addresses.

     • Use SSL: Enable this option to use an SSL-encrypted connection. Specify the following:

       • CA File: The file containing the SSL server certificate authority (CA).

         • Load all CA Certificates: If selected, Hevo loads all CA certificates (up to 50) from the uploaded CA file, else it loads only the first certificate.

           Note: Select this check box if you have more than one certificate in your CA file.

       • Client Certificate: The client’s public key certificate file.

       • Client Key: The client’s private key file.

   • Advanced Settings

     • Load Historical Data: Applicable for Pipelines with Logical Replication mode.
       If enabled, the entire table data is fetched during the first run of the Pipeline.
       If disabled, Hevo loads only the data that was written in your database after the time of creation of the Pipeline.

     • Merge Tables: Applicable for Pipelines with Logical Replication mode.
       If enabled, Hevo merges tables with the same name from different databases while loading the data to the warehouse. Hevo loads the Database Name field with each record.
       If disabled, the database name is prefixed to each table name. Read How does the Merge Tables feature work?

     • Include New Tables in the Pipeline: Applicable for all ingestion modes except Custom SQL.
       If enabled, Hevo automatically ingests data from tables created in the Source after the Pipeline has been built. These may include completely new tables or previously deleted tables that have been re-created in the Source.
       If disabled, new and re-created tables are not ingested automatically. They are added in SKIPPED state in the objects list, in the Pipeline Overview page. You can include these objects post-Pipeline creation to ingest data.

       You can change this setting later.

5. Click TEST CONNECTION. This button is enabled once you specify all the mandatory fields. Hevo’s underlying connectivity checker validates the connection settings you provide.

6. Click TEST & CONTINUE to proceed for setting up the Destination. This button is enabled once you specify all the mandatory fields.

Object and Query Mode Settings

Once you have specified the Source connection settings in Step 4 above, do one of the following:

• For Pipelines configured with the Table or Logical Replication mode:

  1. In the Select Objects page, select the objects you want to replicate and click CONTINUE.

     

     Note:

     • Each object represents a table in your database.

     • From Release 2.19 onwards, for log-based Pipelines, you can keep the objects listed in the Select Objects page deselected by default. In this case, when you skip object selection, all objects are skipped for ingestion, and the Pipeline is created in the Active state. You can include the required objects post-Pipeline creation. Contact Hevo Support to enable this option for your team.

  2. In the Configure Objects page, specify the query mode you want to use for each selected object.

     

     Note: In Full Load mode, Hevo attempts to replicate the full table in a single run of the Pipeline, with an ingestion limit of 25 Million rows.

• For Pipelines configured with the XMIN mode:

  1. In the Select Objects page, select the objects you want to replicate.

     

     Note:

     • Each object represents a table in your database.

     • For the selected objects, only new and updated records are ingested using the XMIN column.

     • The Edit Config option is unavailable for the objects selected for XMIN-based ingestion. You cannot change the ingestion mode for these objects post-Pipeline creation.

  2. Click CONTINUE.

• For Pipelines configured with the Custom SQL mode:

  1. In the Provide Query Settings page, enter the custom SQL query to fetch data from the Source.

  2. In the Query Mode drop-down, select the query mode, and click CONTINUE.

     

Data Replication

Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.

• Historical Data: In the first run of the Pipeline, Hevo ingests all available data for the selected objects from your Source database.

• Incremental Data: Once the historical load is complete, data is ingested as per the ingestion frequency.

Error 1003 - Authentication failure

Error 1006 - Connection settings errors

Error 1011 - Connection settings errors

Error 1012 - Access role issue for logical replication

Error 1014 - Access role issue for logical replication

Error 1017 - Database does not exist

Error 1023 - Connection settings errors

Error 1024 - No pg_hba.conf entry