Table of Contents Previous Next


4 Configuration : 4.3 Configuring the Database Server : 4.3.3 Updating the Configuration file (server section)

Note: The setting in the server section will override the setting in the [BART] section for that particular database server. If omitted, default values will be used.
Enterprisedb for advanced Server database clusters and installed in the mode compatible with Oracle databases
postgres for PostgreSQL database clusters and for Advanced Server database clusters installed in the mode compatible with PostgreSQL databases.
[ServerName] (required) - Specify the server name in the server section of the configuration file. This is the name by which you refer to the database server using BART and the name is case-insensitive when referenced with BART subcommand options. A lowercase conversion of this name is used to create a subdirectory in the BART backup catalog for storing the backups and WAL files for this database server. This parameter is required.
backup_name (optional) – Specify the template for user-defined, friendly names to be assigned to the backups of the database server. The maximum permitted length of backup names is 49 characters.
o
The template is an alphanumeric string that may include the following variables to be substituted by the timestamp values when the backup is taken: 1) %year4-digit year, 2) %month2-digit month, 3) %day2-digit day, 4) %hour – 2-digit hour, 5) %minute2-digit minute, and 6) %second2-digit second. To include the percent sign (%) as a character in the backup name, specify %% in the template.
Note: Do not enclose the template string in quotes even if you want the template to include space characters, otherwise the enclosing quotes are stored as part of the backup name. However, when referenced with the -i option by BART subcommands use of space characters in the backup name requires enclosing the backup name in quotes.
o
This parameter can be overridden by the --backup-name option of the BACKUP subcommand. If this parameter is omitted from the BART configuration file, and the --backup-name option with a user-defined name is not specified with the BACKUP subcommand, then the backup can only be referenced in BART subcommands by the BART assigned, integer backup identifier.
host (required) - Specify the IP address of the database server to be configured for backup.
port (optional) - Specify the port number identifying the database server instance (that is, the relevant database cluster) to be backed up. The default is port 5444.
User (required) – Specify the replication database user name used by BART to:
o
Establish the connection to the database server for full backups
o
Set the Postgres archive_command configuration parameter when running the INIT subcommand
o
Take incremental backups. This database user must be a superuser.
Note: While running as the BART user account, the connection to the database server using this database user must not prompt for a password. Also, the pg_hba.conf file must contain a replication connection entry for this database user name. See Section 4.3.2 for more information.
archive_command (optional) - When the INIT subcommand is used, the content and variables specified in the BART archive_command result in the archive command string to be generated into the Postgres archive_command parameter in the postgresql.auto.conf file.
Note: This BART archive_command parameter in the BART configuration file, and the Postgres archive_command parameter in the postgresql.conf file and the postgresql.auto.conf file refer to two different parameters that are to be set in different manners. Ensure to carefully observe the distinction between the BART archive_command and the Postgres archive_command when configuring these parameters according to the instructions.
o
If the archive_command parameter is omitted, it still results in its usage by the INIT subcommand as if it were actually specified with a setting of 'scp %p %h:%a/%f'. Variables are the following:
o
%ppath of the file to archive used by the Postgres archiving process
o
%hreplaced by the bart_host parameter setting
o
%areplaced by the BART archive path
o
%farchived file name used by the Postgres archiving process.
See Section 4.3.4.2 for additional information.
cluster_owner (required) – Specify the Linux operating system user account that owns the database cluster. This is typically enterprisedb for Advanced Server database clusters installed in the Oracle databases compatible mode, or postgres for PostgreSQL database clusters and for Advanced Server database clusters installed in the PostgreSQL databases compatible mode.
remote_host (optional). Specify the IP address of the remote server to which a backup is to be restored. The value for this parameter must be specified in the form of remote_user@remote_host_address.
o
where remote_user is the user account on the target database server host that accepts a password-less SSH/SCP login connection and owns the directory where the backup is to be restored.
o
Remote_host_address is the IP address of the remote host. For restoring a backup to a remote host or for restoring any backup where remote_user and the BART user account are not the same users, either this parameter must be set or it may be specified with the -r option with the BART RESTORE subcommand.
tablespace_path (optional) – Specify paths to which tablespaces are to be restored specified in the format OID=tablespace_path;OID=tablespace_pathIf the backup is to be restored to a remote host such as specified by the remote_host parameter, then the tablespace paths must exist on the remote host. This parameter is optional.
allow_incremental_backups (optional) –Enables usage of the WAL scanner for incremental backups. Permits taking of an incremental backup when the BACKUP subcommand is invoked with the --parent option.
o
enabled to permit incremental backups.
o
disabled to disallow incremental backups and thus permit only full backups.
o
If the allow_incremental_backups parameter is not specified, the default is disabled.
You can refer EDB Postgres Backup and Recovery Guide section 3.4.3 for information about using the BACKUP subcommand for taking incremental backups and section 3.5 for information about running the WAL scanner.
Description (optional) – Specify the description of the database server. This parameter is optional.

4 Configuration : 4.3 Configuring the Database Server : 4.3.3 Updating the Configuration file (server section)

Table of Contents Previous Next