2.4. Configuring pg_probackup3 #
Once a backup catalog is initialized and a new backup instance is added, you can use the pg_probackup3.conf configuration file located in the directory to fine-tune pg_probackup3 configuration of this instance. backup_dir/backups/instance_name
For example, the backup command uses a regular Postgres Pro connection. To avoid specifying connection options each time on the command line, you can set them in the pg_probackup3.conf configuration file using the set-config command.
Initially, pg_probackup3.conf contains the following settings:
PGDATA— the path to the data directory of the cluster to back up.system-identifier— the unique identifier of the Postgres Pro instance.
Additionally, you can define retention, logging, and compression settings using the set-config command:
pg_probackup3 set-config -Bbackup_dir--instance=instance_name[--external-dirs=external_directory_path] [connection_options] [retention_options] [logging_options]
To view the current settings, run the following command:
pg_probackup3 show-config -Bbackup_dir--instance=instance_name
You can override the settings defined in pg_probackup3.conf when running pg_probackup3 commands via the corresponding environment variables and/or command line options.
Note
It is not recommended to edit pg_probackup3.conf manually. Modifying the configuration file using the set-config command prevents accidental typographical errors.