PostgreSQL

This section explains how to set up a PostgreSQL source in a data task. Before you start the data task, make sure that you have fulfilled the Prerequisites, set up the Limitations and considerations, and familiarized yourself with the Required permissions.

You need to configure connectivity to PostgreSQL when landing data from any of the following databases:

• On-premises:

  • PostgreSQL

    Information noteThe PostgreSQL on-premises source also supports landing from Azure Database for PostgreSQL - Flexible Server.

• Cloud-based:

  • Amazon Aurora

  • Amazon RDS for PostgreSQL

  • Microsoft Azure Database for PostgreSQL

  • Google Cloud SQL for PostgreSQL: Requires Data Movement gateway 2022.11.42 or later

  • Google Cloud AlloyDB for PostgreSQL: Requires Data Movement gateway 2023.5.10 or later.

Setting connection properties

This section describes the available connection properties. All properties are required unless otherwise indicated.

Data source

• Data gateway: The name of the Data Movement gateway to use to access your data.

• Cloud provider: If your PostgreSQL database is located in the cloud, select the provider:

  • None (select if your PostgreSQL database is on-premises)

  • Amazon Aurora

  • Amazon RDS

  • Microsoft Azure

  • Google Cloud - Requires Data Movement gateway 2022.11.42 or later.

• Server: The host name or IP address of the computer on which the PostgreSQL database is installed.

• Port: The port through which the Data Movement gateway will access the PostgreSQL database. The default is 5432.

Account properties

User Name and Password: The user name and password of a user authorized to access the PostgreSQL database.

Database properties

Database name: There are two methods you can use to specify a database:

• Method 1 - Select from a list: Click Load databases and then select a database.
• Method 2 - Manually: Select Enter database name manually and then enter the database name.

SSL options

You can configure Qlik Data Gateway - Data Movement to connect to the data source using SSL.

• SSL Mode: Select one of the following:
  • None - Connect with a surname and password only.
  • Preferred - Establishes an encrypted connection if the server supports encrypted connections, falling back to an unencrypted connection if an encrypted connection cannot be established.
  • Required - Establishes an encrypted connection if the server supports encrypted connections. The connection attempt fails if an encrypted connection cannot be established.
  • Verify CA - Similar to Required, but also verifies the server Certificate Authority (CA) certificate against the configured CA certificates. The connection attempt fails if no valid matching CA certificates are found.
  • Verify Full - Similar to Verify CA, but also performs host name identity verification by checking the host name the client (i.e. Qlik Data Gateway - Data Movement) uses for connecting to the server against the identity in the certificate that the server sends to the client. The client checks whether the host name that it uses for connecting matches the Common Name value in the server certificate. The connection fails if there is a mismatch.
• Trusted certificate: The Certificate Authority (CA) that issued the client certificate file in PEM format.
• Client certificate: The client certificate requested by the server.
• Client certificate key: The client private key file in PEM format.
• CRL: The CRL certificate. This file contains certificates revoked by certificate authorities. If the server certificate appears in this list, the connection will fail.
• SSL compression: Select this option to compress the data before it is encrypted.

CDC properties

WAL heartbeat - A CDC task that is running but not capturing changes (due to source table inactivity) will continue to occupy the LSN position in the slot allocated to the task, thereby preventing truncation of the WAL. Since the WAL is a server-wide resource used by all PostgreSQL processes, it may grow extremely large if no changes are captured for an extended period.

To prevent this from happening, enable the WAL heartbeat option. When this option is enabled, the PostgreSQL source connector mimics task activity by periodically committing pseudo transactions (referred to as "Heartbeats") to the heartbeat table, thereby advancing the task slot’s LSN position.

• Schema for heartbeat artifacts: The schema in which the WAL heartbeat table (attrep_wal_heartbeat) will be created. The default value is "public".
• Heartbeat frequency (minutes): The frequency with which to commit transactions to the heartbeat table.

DDL properties

• Capture DDL events: When this option is selected, the following operations occur:
  • To facilitate capture of DDL events, Data Movement gateway creates triggers and other operational artifacts in the PostgreSQL database when the task starts. You can later remove these artifacts as described in Removing artifacts from the source database below.
  • Streamed DDL events are captured.
• Create DDL artifacts in schema: The schema in which the operational DDL database artifacts will be created. The default value is "Public".

Removing artifacts from the source database

In order to capture DDLs, Data Movement gateway creates various artifacts in the PostgreSQL database when the task starts. You can remove these artifacts if you decide to delete the task at some point in the future.

To remove the artifacts, execute the following statements (in the order they appear below), where public is the default schema in which the artifacts were created:

• drop event trigger attrep_intercept_ddl

  Information noteThe event trigger does not belong to a specific schema.
• drop function public.attrep_intercept_ddl()
• drop table public.attrep_ddl_audit
• drop schema public

• drop table schema.attrep_wal_heartbeat

  where schema is the Schema for heartbeat artifacts specified in the connector settings.

Internal properties

Internal properties are for special use cases and are therefore not exposed in the dialog. You should only use them if instructed by Qlik Support.

Use the and buttons to the right of the fields to add or remove properties as needed.

Name

The display name for the source connection.