Delphix-initiated single database backup

This ingestion method uses a pg_dump logical backup, initiated by Delphix, between the source and staging databases.

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, and execute permissions on the unix_socket_directories configured in postgresql.conf file (The defaults are /var/run/postgresql and /tmp).

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

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

For more information, refer to Requirements and Prerequisites. 

Procedure

After you add an environment and create a source configuration, continue with the following method-specific steps in the Create and Link dSource wizard.

1. 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.
      If you are using Privilege Elevation, provide the username of the Privileged OS Account. Once the dSource is created, you cannot update the Privileged OS Account. Recreating the dSource is the only way to make changes. The Unix Privileged Username must begin with a letter or an underscore, followed by letters, digits, underscores or dashes. They can end with a dollar sign.

2. Select the Delphix Initiated Backup - Single Database Ingestion checkbox. This allows Delphix to initiate the logical backup on the source database.
   

3. Click +Add next to the Single Database Ingestion method.

   Click the +Add button for Single Database Ingestion only once. The solution supports a single backup path; providing multiple paths will cause an error during linking.

4. Provide the values in the following fields.

   • Microsoft Azure Entra Authentication: Default: false. If selected, the az utility must be installed on the staging host.

   • Hashicorp Vault for Credential Management, Default: false. Enables credential retrieval from a HashiCorp Vault instead of inline credentials. If HashiCorp Vault for Credential Management is selected, the Source Postgres Database User Name and Password fields are hidden. Instead, provide: Vault credentials Supplier = HashiCorp Vault Credentials; the Vault server (from the dropdown of HashiCorp Vaults added to the Delphix Continuous Data Engine); the Delphix Continuous Data Engine name where credentials are stored; the path where the secrets are stored; the keys for username and password; and Type of Secret = any.

   • Source Postgres Database Name: Name of the source PostgreSQL database.

   • Source Postgres Database User Name: Username of the PostgreSQL database. Default: postgres.

   • Source Postgres Database User Password: Password for the source user. From connector version 2026.1.0, when Microsoft Azure Entra Authentication is selected, a placeholder password is not needed. In version 2025.1.0, a placeholder password was required.

   • Source Postgres DB Host: Hostname or IP address of the source PostgreSQL host.

   • Source Instance Port Number: Port number of the source instance. Default: 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: Default: 2.

   • Number of Restore Jobs: Default: 2.

   • Target Clone Database Name (Optional): Allows renaming of the database during linking in the Single Database Ingestion workflow.

   • Source SSL Enabled: Default: false. When Source SSL Enabled is selected, provide: SSL Mode (default: require; choose from the dropdown; used to connect to the source database); and SSL Root Certificate Path (absolute path to the root certificate file such as server-ca.pem on the staging host — required for verify-ca and verify-full; optional but recommended for allow, prefer, and require). The SSL root certificate file must have read permissions for the environment user.

   • Staging Instance Port Number: A unique, free port on the staging instance.

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

5. Optionally, define database configuration parameters in the Config Settings section as needed. Specify a parameter name and value to update an existing parameter in postgresql.conf. To disable a parameter, specify the parameter name and select the Comment Property check box.

6. Click Next.

7. 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. Specify your staging environment, user, and snapshot parameters. Select the Resynchronize dSource checkbox to force a non-incremental load of data from the source. This operation is similar to creating a new dSource, but prevents duplication of storage and maintains timeflow history. Click Next.

9. Apply policy details to the dSource if needed, then click Next.

10. 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.

11. Review the configuration profile for your dSource and click Submit.

12. The Delphix Continuous Data Engine will initiate two jobs, DB_Link and DB_Sync, to create the dSource. Monitor the jobs by selecting Admin > Operations in the top menu bar. On successful completion of the DB_Link job, the database icon changes to a dSource icon under Data > Data Management > dSources.

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

13. After the dSource is created successfully, open the dSource Configuration tab to view details and make modifications to policies and permissions.

14. In the Datasets panel, select the specific dSource and navigate to the Configuration tab to view source files, data management configuration, and hook operations.