Prerequisites

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

• The PostgreSQL version is 9.5 or higher.

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

  Note: PostgreSQL versions 15.8 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.

• Database hostname and port number of the Source instance are available.

• 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 Azure PostgreSQL Source:

Step 1

Create a Read Replica (Optional)

Step 2

Set up Log-based Incremental Replication

Hevo supports data ingestion from PostgreSQL servers via Write Ahead Logs set at the logical level (available on PostgreSQL version 9.4). A Write Ahead Log(WAL) is a collection of log files that record information about data modifications and data object modifications made on a PostgreSQL server instance. Typically WAL is used for data replication and data recovery.

By default, the replication method is set to REPLICA. You must change it to LOGICAL.

To do this:

1. Log in to the Azure Portal.

   

2. Under Resources, Recent tab, select the database for which you want to change the replication mode. For example, hevo-postgres in the image below.

   

3. In the left navigation pane of your <Database Name> page, under Settings, click Server Parameters.

4. In the Search bar, type wal_level and update the value to LOGICAL, and then click Save.

   

5. Click Save and Restart in the confirmation dialog to restart the PostgreSQL server for the parameter changes to take effect.

   

Step 3

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. You can do this by creating firewall rules in your Microsoft Azure database settings as follows:

1. Log in to the Azure Portal.

2. Under Resources, Recent tab, select the database you want to synchronize with Hevo.

   

3. In the left navigation pane, under Settings, click Networking.

4. Create a Firewall Rule:

   1. Specify a Firewall rule name.

   2. Specify Hevo’s IP addresses in the Start IP address and End IP address fields as per your region.

      Note: As Hevo has specific IP addresses and not a range, the value in the Start IP address and End IP address fields will be the same.

      

   3. Click Save.

   4. Repeat this step to add the IP address for each applicable Hevo region.

Step 4

Create a Database User and Grant Privileges

1. Create a database user (optional)

2. Grant privileges to the user

The database user specified in the Hevo Pipeline must have the following privileges:

• SELECT

• USAGE

• CONNECT

• REPLICATION

To assign these privileges:

1. Connect to your Azure PostgreSQL database instance as a user with admin privilege using an SQL client tool, such as psql.

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: If you want to use Log-based Incremental Replication, grant the REPLICATION permission to the database user. Log in to the database as a user with admin privilege and run the following command:

   ALTER ROLE <database_username> WITH REPLICATION;
   

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

Step 5

Retrieve the Hostname and Port Number (Optional)

Step 6

Specify Azure PostgreSQL Connection Settings

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

1. Click PIPELINES in the Navigation Bar.

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

3. On the Select Source Type page, select Azure PostgreSQL.

4. On the Configure your Azure PostgreSQL Source page, specify the following:

   

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

   • Select Server Type: The deployment mode of your Azure PostgreSQL server. This can be either Flexible Server or Single Server. Default value: Flexible Server.

   • Database Host: The Azure PostgreSQL host’s IP address or DNS. For example, postgres.database.azure.com.

     Note: For a URL-based hostname, exclude the http:// or https:// part. For example, if the hostname URL is https://postgres.database.azure.com, enter postgres.database.azure.com.

   • Database Port: The port on which your Azure 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, on 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 6 above, do one of the following:

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

  1. On 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. On 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. On 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. On 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