Welcome to Backup Agent
A Basic Introduction to Backup Agent
Backup Agent provides an alternative method for implementing the Continuous Operations function provided with PSQL.
•
Backup Agent Overview
•
Backup Agent Components
•
PSQL Database Engine Requirements for Backup Agent
Backup Agent Overview
Backup Agent provides a quick and simple method for you to set and manage Continuous Operations on your PSQL database files. Setting and managing Continuous Operations is a critical piece when backing up your PSQL databases. Backup Agent automatically handles setting and managing Continuous Operations on your open files so that your data is still available from your application during your backup. Once the backup procedure is complete, stopping Backup Agent automatically takes the files out of Continuous Operations and rolls in all the changes captured during the backup.
Product Features
Backup Agent works seamlessly with many of the most popular backup applications on the market today.
Backup Agent automatically manages files that are opened during a backup for you, unlike the Continuous Operations feature in the PSQL utilities, which requires that you to enter a list of specific file names.
Lastly, once you have installed Backup Agent with PSQL and implemented the agent to work with your specific backup routine, you are ready to start backing up your PSQL databases. There are no special configuration settings required.
Note Backup Agent does not backup your PSQL database files; it is designed to complement your current backup solution.
Backup Agent is an optional product included with the current versions of PSQL Server and PSQL Vx Server. See also Table 1‑1.
By default, Backup Agent is not installed. You must install it from the PSQL media after you install the PSQL database engine. Select Backup Agent on the installation selection dialog.
Licensing
No separate key for Backup Agent is required if the product is installed on the same machine as the current version of PSQL Server or PSQL Vx Server. You are not prompted for a key if the machine is running either product on Windows. Similarly, you are not required to apply a key if the machine is running Linux or OS X.
See Table 1‑1 for details on when a key is required for Backup Agent.
If you are using Backup Agent as a separate product, note that it supports installation on only one machine. You may install an evaluation version of Backup Agent without a key. At the end of the evaluation period, Backup Agent returns an error message when it attempts to start.
If you initially installed an evaluation version, you may later apply a permanent key using License Administrator. For detailed information on using the License Administrator GUI (Windows only), refer to the “License Administration” chapter in PSQL User's Guide. On Windows or in a Workgroup Engine installation, you may also administer keys through the command line utility clilcadm. For full details about clilcadm, see the “License Administration” chapter in PSQL User's Guide.
Backup Agent Components
This section discusses the components that make up Backup Agent. The two utility components along with the Software Developer Kit (SDK) give you three ways to easily incorporate the agent into your backup routine, depending on your business needs.
Command Line Utility
The command line interface (CLI) utility (pvbackup.exe) is one access method Backup Agent offers. For implementation with any of the popular backup products on the market, simply add the executable commands into pre- and postcommand settings. With this implementation, your backup software automatically starts the agent before backing up and stops it after the backup finishes. Using this method ensures that your regularly scheduled backups include consistent and reliable PSQL data.
GUI Utility
Another access method for Backup Agent is the graphical user interface (GUI) utility (pvbackupgui.exe), which is available from the Start menu or Start screen or from within PSQL Control Center. In this interface you can start and stop the agent at the touch of a button – without having to recall commands or parameters required for the command line interface. Using this method allows you the flexibility to perform backups as needed of your PSQL data quickly and almost effortlessly.
The GUI utility is available only on Windows platforms.
Controller
The Controller component of Backup Agent consists of a DLL that provides a common interface for the agent utilities. The Controller handles all communications with the Event Handler.
Durable File List
The Durable File List (dfl.txt) is located in the program’s data path and is generated by Backup Agent. The default location for the data path is set at installation as <PSQL Application Data directory>\PBA\Data. This file contains a list of all the files in Continuous Operations at any given time. When a file goes into Continuous Operations, it is automatically added to the list. Similarly, when a file is taken out of Continuous Operations, it is then removed from the list.
Exclude File List
The Exclude File List (efl.txt) is located in <PSQL Application Data directory>\PBA\Data. You can exclude files from being placed into Continuous Operations by Backup Agent by listing them in the exclude file list.
Event Handler
The Event Handler is the workhorse inside Backup Agent. The primary purpose of this component is to intercept files as they are opened so that they can be placed in Continuous Operations. Backup Agent works in conjunction with the database engine and the Controller to handle all the operations, or events, requested through the Backup Agent interfaces. As the name implies, the Event Handler handles all the events going on inside Backup Agent.
Include File List
The Include File List (ifl.txt) is located in <PSQL Application Data directory>\PBA\Data. You can include files to be placed into Continuous Operations by Backup Agent by listing them in the include file list.
Files in this list will be placed into Continuous Operations as soon as Backup Agent is turned on, whether or not the files are currently opened by the PSQL engine.
Log File
Backup Agent maintains a file called baevent.log that reports informational and warning messages from the event handler. On Windows platforms, this file is located in <PSQL Application Data directory>\PBA\Logs. On Linux and OS X, it is in /usr/local/psql/pba/logs. The locations are set at installation and are not configurable.
The maximum size for the log file is preset to 50 MB and cannot be changed. When this limit is reached, the file is automatically renamed for archival purposes, using a naming convention of baevent.1, baevent.2, and so on. Backup Agent maintains a maximum of five archived log files.
Software Developer Kit (SDK)
Under Windows, Backup Agent includes an application programming interface (API) so that developers can embed Backup Agent directly into a software application. The API, along with the necessary header and library files, compose the SDK. Integrating Backup Agent directly into your application using the SDK provides the highest level of backup data assurance.
Backup Agent Release Notes
We strongly recommend that you view the readme file (readme_ba.htm) before installing Backup Agent. This file contains important information that may not have been included in the product documentation but may be essential to your installation and use of the product.
The readme file is located at the root on the installation CD.
You may also refer to the readme file after installation. On Windows platforms, you can access the file from the installation location. On Linux and OS X platforms, the file is located in the /usr/local/psql/pba/doc/ folder.
Finally, the latest copy of the release notes is always posted at the PSQL website.
PSQL Database Engine Requirements for Backup Agent
The current version of Backup Agent is supported on the following PSQL releases. The current version is not supported on any previous versions of PSQL.
Table 1‑1
Current Backup Agent Supported By PSQL Releases
PSQL Product
Release
Bitness
Windows
Linux
OS X
Server
v111
v11 SP11
v11 SP22
v11 SP32
v122
v132
32-bit
64-bit
Yes
Yes
Yes
Vx Server
112
11 SP32
122
132
32-bit
64-bit
Yes
Yes
Yes
Workgroup
v111
v11 SP11
v11 SP21
v11 SP31
v121
v131
32-bit
Yes
Not applicable
Not applicable
1 A separate key for Backup Agent is required if the product is installed on the same machine as this product. You may first install an evaluation copy of Backup Agent and apply the key later.
2 No separate key for Backup Agent is required if Backup Agent is installed on the same machine as this product.