3.3 Basic BART Subcommand Usage

Invoke the bart program (located in the BART_HOME/bin) directory with the desired subcommand and any applicable subcommand options to manage BART:

•	CHECK-CONFIG. Check the setting of the parameters in the BART configuration file and the proper setup of the database servers for WAL archiving and taking of backups. See Section 3.4.1.

•	INIT. Create the BART backup catalog directories, rebuild the backupinfo files, and set the archive_command in the Postgres server based on the setting of the archive_command in the bart.cfg. See Section 3.4.2 for details.

•	BACKUP. Take a full backup or an incremental backup. See Section 3.4.3.

•	SHOW-SERVERS. Display the database servers managed by BART. See Section 3.4.4.

•	SHOW-BACKUPS. Display information for the backups taken by BART. See Section 3.4.5.

•	VERIFY-CHKSUM. Verify the checksums on the full backups. See Section 3.4.6.

•	MANAGE. Manage backups using the retention policy. Compress the archived WAL files. See Section 3.4.7.

•	RESTORE. Restore a backup and generate an appropriate recovery.conf file including, if desired, a restore_command for restoring archived WAL files for point-in-time recovery. See Section 3.4.8.

•	DELETE. Delete a backup. See Section 3.4.9.

For instructions and information about using the BART WAL scanner, see Section 3.5.

General BART Options

There are a number of general BART options that can be given immediately following specification of the bart program. Following the general BART options (if any are given), you can specify a BART subcommand.

•	When invoking a subcommand, the subcommand name is case-insensitive (that is, the subcommand can be specified in uppercase, lowercase, or mixed case).

•	Each subcommand has a number of its own applicable options that are specified following the subcommand. All options are available in both single-character and multi-character forms.

•	The option keywords must generally be in lowercase except when specified differently in this section.

•

When invoking BART, the current user must be the BART user account. Determine the operating system user account that will be used to run the BART command line program. This operating system user is referred to as the BART user account. The chosen operating system user account must have the following capabilities:

The BART user account must:

o	Own the BART backup catalog directory.

o	Be able to run the bart program and the bartscanner program.

o	Have a password-less SSH/SCP connection established between database servers managed by BART.

For example, enterprisedb or postgres can be selected as the BART user account when the managed database servers are Advanced Server or PostgreSQL respectively.

The general syntax for invoking BART is the following:

bart [ gen_option ]... [ subcmd ] [ subcmd_option ]...

The following are the general BART options denoted as gen_option in the above syntax diagram.

Options

-h, --help

Displays general syntax and information on BART usage.

-v, --version

Displays the BART version information.

-d, --debug

Displays debugging output while executing BART subcommands.

-c, --config-path config_file_path

Specifies config_file_path as the full directory path to a BART configuration file. Use this option if you do not want to use the default BART configuration file BART_HOME/etc/bart.cfg.

Setting Path Environment Variable

If execution of BART subcommands fails with the following error message, then you need to set the LD_LIBRARY_PATH to include the libpq library directory:

./bart: symbol lookup error: ./bart: undefined symbol: PQping

Set the LD_LIBRARY_PATH environment variable for the BART user account to include the directory containing the libpq library. This directory is POSTGRES_INSTALL_HOME/lib as shown by the following example:

export LD_LIBRARY_PATH=/opt/PostgresPlus/9.6AS/lib/:$LD_LIBRARY_PATH

It is suggested that the PATH and the LD_LIBRARY_PATH environment variable settings be placed in the BART user account’s profile. See Step 2 in Adding Configuration Parameter Values Section of the EDB Postgres Backup and Recovery Installation and Upgrade Guide for details.

The following examples illustrate the previously described ways for invoking BART. The BART user account is bartuser in these examples.

$ su bartuser

Password:

$ export LD_LIBRARY_PATH=/opt/PostgresPlus/9.6AS/lib/:$LD_LIBRARY_PATH

$ ./bart SHOW-SERVERS

Run BART from any current working directory:

$ su bartuser

Password:

$ export LD_LIBRARY_PATH=/opt/PostgresPlus/9.6AS/lib/:$LD_LIBRARY_PATH

$ bart SHOW-SERVERS

Use a BART configuration file other than BART_HOME/etc/bart.cfg:

$ su bartuser

Password:

$ export LD_LIBRARY_PATH=/opt/PostgresPlus/9.6AS/lib/:$LD_LIBRARY_PATH

$ bart -c /home/bartuser/bart.cfg SHOW-SERVERS

The following section describes the BART subcommands.