Delphix-initiated single database backup

The following diagram demonstrates the architecture of the Delphix Continuous Data Engine support for the PostgreSQL database with pg_dump logical backup between source and staging database.

Perform the following steps to create a dSource with a Delphix-initiated backup that uses a single database backup to stay in sync with the source.

Prerequisites

Ensure that you meet the following requirements before you begin creating a dSource.

• The environment requirements are met by the source and staging environments as described in Requirements for PostgreSQL Staging and Target environments.

• The environment user or the privileged user must have the following permissions:

  • access to the Postgres commands

  • read+write+execute permissions on the unix_socket_directories configured in postgresql.conf file (The default directories are /var/run/postgresql & /tmp).

• The high-privilege user must have the following permissions:

  • Write+execute permissions on the PostgreSQL Backup Dump Directory.

• Refer to the Advanced configuration page to enable OPTIMIZE_RESTORE_PARAMETERS = true in dlpx_postgres_config.ini, before triggering RESYNC or DB_SYNC job.

For more information, refer to Requirements and Prerequisites. 

Procedure

Perform the following steps to create a dSource using the Delphix-initiated single database backup ingestion.

1. Login to the Delphix Management application.

2. Navigate to the Manage > Environments page.

3. On the Databases tab, choose a repository for your dSource and click the + icon.

4. In the Add Database dialog window, provide the name of your source configuration and click Add.

5. Select your source configuration and click the Add dSource link located on the right.

6. In the Source tab, do the following:

   1. In the NFS Mount Location field, provide a mount location on the staging environment.

   2. (optional) Select the Privileged OS Account option to enter the Privileged Unix Username to create the dSource. Leave this blank if you do not want to use Privilege Elevation. For more information, read the Prerequisites section.
      If you are using Privilege Elevation, provide the username of the Privileged OS Account. Once the dSource is created, you will not be able to update the Privileged OS Account. Recreating the dSource account is the only way to make changes. The Unix Privileged Username should begin with a letter or an underscore, followed by letters, digits, underscores or dashes. They can end with a dollar sign.

   3. Select the Delphix Initiated Backup - Single Database Ingestion checkbox. Enabling this checkbox allows Delphix to initiate the logical backup on the source database.
      

   4. Click on the +Add icon next to the Single Database Ingestion method parameter.

      

      You must click the “Add Button” for Single Database Ingestion method only once as the solution supports a single backup path. Providing multiple paths will result in an error during the linking process. For more information, read the PostgreSQL VDB tables missing after single database ingestion page.

   5. Provide the values in the following fields.

      • Microsoft Azure Entra Authentication, The default value is false.

        If the Microsoft Azure Entra Authentication is selected then make sure az utility is installed on staging host.

        

      • Use the Hashicorp Vault for Credential Management, the default value is false.

      • Source Postgres Database Name

      • Source Postgres Database User Name. The default value is postgres.

      • Source Postgres Database User Password Starting connector version 2026.1.0, when the Microsoft Azure Entra Authentication is selected then placeholder password is not needed. In 2025.1.0 connector version, A placeholder password was needed.

      • If the Hashicorp Vault for Credential Management is selected, the fields for Source Postgres Database User Name and Password will not appear. Enter the following details:

        • Select the Vault credentials Supplier to Hashicorp Vault Credentials from the drop down.

          

        • Select the Vault server from the drop down. This drop down will include all the Hashicorp Vaults added to the Delphix Continuous Data Engine.

        • Provide the Delphix Continuous Data Engine name where the credentials are stored.

        • Provide the path where the secrets are stored.

        • Provide the keys for the username and password.

        • Select the Type of Secret to any.

          

      • Source Postgres DB Host

      • Source Instance Port Number. The default value is 5432.

      • Postgres Backup Dump Directory: Provides the directory on the staging environment on which the backup will be created. This directory should already exist in the staging environment and must have read and write access for the environment user.

      • Number of Backup Jobs: The default value is 2.

      • Number of Restore Jobs: The default value is 2.

      • Target Clone Database Name (Optional): Provides the flexibility to rename database during linking in the Single Database Ingestion workflow.

      • Source SSL Enabled: The default value is false

        • When the Source SSL Enabled is selected, enter these input fields details on the dSource wizard:

        • SSL Mode: The default value is require, End user can select the desired mode from drop down list. This SSL Mode is used to connect to source database..

        • SSL Root Certificate Path: Absolute path to the SSL root certificate file (for example, server-ca.pem) on the staging host. Required for sslmode: verify-ca and verify-full. Optional but recommended for allow, prefer, and require modes.

          

          SSL root certificate file should have read permissions for environment user

      •  (Optional) Staging postgresql.conf config file: Provides the path to a PostgreSQL configuration template file that will be used when starting the dSource.

        
        

   6. Specify the Staging Instance Port Number. This port number must be unique and the port must be free for a given instance.

   7. Optionally, you can define database configuration parameters during the linking operation in the "Config Settings" section if needed.

   
   

h. Click Next.

7. In the dSource Configuration tab, provide a dSource name and then select a group for your dSource. Adding a dSource to a dataset group allows you to manage user permissions for that database and its objects, including snapshots. For more information, refer to the topics under Users and Groups.

8. In the Data Management tab, select desired staging environment and user from drop down list, and snapshot parameters. You must select the Resynchronize dSource check box in the Add dSource wizard. This operation will force a non-incremental load of data from the source. Click Next to proceed.

9. In the Policies tab, apply policy details to the dSource if needed, and then click Next to continue.

10. In the Hooks tab, select a Hook Point and then click + to add a script you want to run at that hook point. You can define scripts to run at multiple hook points in the process.

11. In the Summary tab, review the configuration profile for your dSource.

12. Click Submit. The Delphix Continuous Data Engine will initiate two jobs, namely DB_LINK and DB_SYNC to create the dSource. You can monitor these jobs by selecting System>Jobs or by selecting System >Events in the top menu bar. Upon successful completion of the DB_link job jobs, the database icon will change to a dSource icon on the Environments > Host > Databases screen. The dSource will also be listed under Datasets within its assigned group.

    The dataset must not be disabled after failed or canceled RESYNC job. For more information, read the Best practices for the RESYNC job topic.