Quest NetVault Backup Plug-in for PostgreSQL

Transcription

1 Quest NetVault Backup Plug-in for PostgreSQL version 3.0 User s Guide PSG EN-01 07/16/13

2 2007 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser s personal use without the written permission of Quest Software, Inc. The information in this document is provided in connection with Quest products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest products. EXCEPT AS SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Quest does not make any commitment to update the information contained in this document. If you have any questions regarding your potential use of this material, contact: Quest Software World Headquarters LEGAL Dept 5 Polaris Way Aliso Viejo, CA legal@quest.com For regional and international office information, refer to the web site ( Trademarks Quest, Quest Software, the Quest Software logo, Simplicity at Work, FlashRestore, GigaOS, and NetVault are trademarks and registered trademarks of Quest Software, Inc., and its subsidiaries. For a complete list of Quest Software s trademarks, see Other trademarks and registered trademarks are property of their respective owners. Patents This product is protected by U.S. Patents # 7,814,260; 7,913,043; 7,979,650; 8,086,782; 8,145,864; 8,171,247; 8,255,654; and 8,271,755. Protected by Japanese, E.U., French and UK patents and , and German patent DE Additional patents pending.

3 Table of Contents Chapter 1: Introducing Plug-in for PostgreSQL 5 Quest NetVault Backup Plug-in for PostgreSQL At a Glance... 5 Key Benefits... 6 Feature Summary... 6 Target Audience... 7 Recommended Additional Reading... 7 About Quest Software Contacting Quest Software Contacting Quest Support... 8 Chapter 2: Installing and Removing the Plug-in 9 Installation Prerequisites... 9 Reviewing the Recommended Configuration... 9 Installing the Plug-in Removing the Plug-in Chapter 3: Configuring the Plug-in 13 Adding a Database Cluster Correcting Invalid Parameters Reconfiguring an Added Database Cluster Removing an Added Database Cluster...17 Setting Default Action for an Error Condition Accessing the Configure Dialog from the Client Management Window Accessing the Configure Dialog from the Configurator...19 Chapter 4: Backing Up Data 21 Defining a Backup Strategy Supported Backup Formats Available Backup Types Backup Strategy Considerations... 23

4 4 Table of Contents - Example Backup Sequences Backing Up Data with the Plug-in Selecting Data for Backup Choosing Backup Type and Format Setting Backup Options Specifying Action for an Error Condition Finalizing and Submitting the Job Backing Up Global Objects Only...30 Backing Up Configuration Files...31 Chapter 5: Restoring Data 33 Restoring Data with the Plug-in Selecting Data for a Restore Setting Restore Options Finalizing and Submitting the Job Restoring Global Objects...40 Restoring Configuration Files...41 Renaming a Database during Restore...42 Restoring Data to a Different Database Cluster Prerequisites Restore Procedure Restoring to Database Cluster on Alternate Server Prerequisites Restore Procedure Appendix A: Troubleshooting 47 Troubleshooting...47

5 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 5 Chapter 1: INTRODUCING PLUG-IN FOR POSTGRESQL Quest NetVault Backup Plug-in for PostgreSQL At a Glance Key Benefits Feature Summary Target Audience Recommended Additional Reading About Quest Software Contacting Quest Software Contacting Quest Support Quest NetVault Backup Plug-in for PostgreSQL At a Glance The Quest NetVault Backup (NVBU) Plug-in for PostgreSQL (Plug-in for PostgreSQL) increases confidence in recoverability of critical data and eliminates the need for writing complex backup and recovery scripts. Through an intuitive GUI and automated workflow process, the plug-in offers a centralized console to set up, configure, and define backup and restore policies for the PostgreSQL databases. Support for database cluster backups, individual database and table backups in different backup formats, namely Plain-text SQL Script, TAR Archive, and Custom Archive formats, gives you the flexibility to implement a backup policy that is flexible enough to account for a number of recovery scenarios without learning PostgreSQL internals. The plug-in offers granular control over restores and minimizes downtime by allowing you to restore entire database cluster, individual databases, or individual tables more reliably. Through automatic integration with a wide range of backup devices, you can be confident that your PostgreSQL data is protected and safely stored offsite to meet your disaster recovery and business continuity goals.

6 6 Chapter 1 Introducing Plug-in for PostgreSQL Key Benefits Increases Confidence and Reduces Risk While Deploying PostgreSQL Plug-in for PostgreSQL enables total protection of the PostgreSQL databases without requiring you to write complex backup scripts. The plug-in offers the flexibility to back up the entire database cluster, individual databases, or tables in any of the supported backup formats, which can be used to reconstruct entire or parts of database in the unfortunate event of data loss. By relying on the plug-in to implement your backup policies, you can be confident that your data will be protected, and you will be able to recover exactly what is needed in the unfortunate event of a failure. Speeds up Restores and Reduces Downtime With Plug-in for PostgreSQL, DBAs are no longer required to write scripts or manually execute restore commands to recover lost data. Just select what needs to be restored from a saved backup set using the point-and-click feature, and the plug-in will recover the data without further interaction. The restores are faster due to reduced human interaction, and the chance for a syntax error in a manual execution that would require a restart is eliminated. Ensures Business Continuity with Automatic Integration of Backup Devices Plug-in for PostgreSQL takes advantage of NVBU's fundamental integration with a wide range of backup devices, and enables data backups to tape libraries, stand-alone devices, virtual tape libraries, or shared virtual tape libraries. You have the flexibility to take a quick backup on virtual tape libraries, and then later on duplicate this data to physical tape libraries. The ability to store data at offsite locations gives you the confidence that your PostgreSQL environment is protected for disaster recovery purposes. With Plug-in for PostgreSQL, the administrators need not be present 24x7. Even less experienced administrators can initiate restores with the certainty that they will be performed correctly and quickly, thereby reducing downtime and improving business continuity Feature Summary Backup Features Full database cluster, or individual database/table backups Plain-text SQL Script, Tar Archive, and Custom Archive backup formats Protection down to the table level Global Objects only backups Template database backup Data only backups

7 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 7 Configuration files backup Restore Features Restore entire cluster, individual databases or tables Rename databases during restore Restore to alternate PostgreSQL database cluster Other Features Intuitive point-and-click GUI Automatic integration with storage devices Job scheduling Target Audience While advanced DBA skills are generally not required to create and execute routine backup operations, they are required for defining the PostgreSQL Database Backup and Recovery Strategy Recommended Additional Reading Quest Software recommends that you have the following documentation available for reference while setting up and using this plug-in. PostgreSQL documentation PostgreSQL PostgreSQL PostgreSQL NVBU Documentation: Quest NetVault Backup Installation Guide This guide provides complete details on installing the NVBU Server and Client software. Quest NetVault Backup Administrator s Guide This guide describes how to use NVBU and provides comprehensive information on all NVBU features and functionality. Quest NetVault Backup Configuration Guide This guide explains how to change the preferences and default settings for NVBU. Quest NetVault Backup Command Line Interface Reference Guide This guide provides a detailed description of the command line utilities.

8 8 Chapter 1 Introducing Plug-in for PostgreSQL You can download these guides from the Quest web site at: About Quest Software Established in 1987, Quest Software (Nasdaq: QSFT) provides simple and innovative IT management solutions that enable more than 100,000 global customers to save time and money across physical and virtual environments. Quest products solve complex IT challenges ranging from database management, data protection, identity and access management, monitoring, user workspace management to Windows management. For more information, visit Contacting Quest Software Mail: Web site: info@quest.com Quest Software, Inc. World Headquarters 5 Polaris Way Aliso Viejo, CA USA For regional and international office information, refer to the web site Contacting Quest Support Quest Support is available to customers who have a trial version of a Quest product or who have purchased a Quest product and have a valid maintenance contract. Quest Support provides unlimited 24x7 access to our Support Portal at From our Support Portal, you can do the following: Retrieve thousands of solutions from our Knowledge Base. Download the latest releases and service packs. Create, update, and review Support cases. View the Global Support Guide for a detailed explanation of support programs, online services, contact information, policies, and procedures. The guide is available at

9 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 9 Chapter 2: INSTALLING AND REMOVING THE PLUG-IN Installation Prerequisites Reviewing the Recommended Configuration Installing the Plug-in Removing the Plug-in Installation Prerequisites Before installing Plug-in for PostgreSQL, make sure that the following software is installed and properly configured on the machine designated as the PostgreSQL server: NVBU Server/Client Software (ver or later) At least the Client version of NVBU software ver or later must be installed on the machine configured as the PostgreSQL server. PostgreSQL Software (ver. 8.0 or later) The machine must be running PostgreSQL version 8.0 or later. The Custom Archive backup format requires the zlib compression library. This library is included by default during PostgreSQL installation unless you specify the --without-zlib option. Do not use the --without-zlib option if you intend to use Custom Archive backup format Reviewing the Recommended Configuration While you can set up a single machine as both the NVBU Server and the PostgreSQL Server (that is, all software installation and configuration requirements are performed on a single machine), Quest Software recommends that these two entities exist on separate machines.

10 10 Chapter 2 Installing and Removing the Plug-in Network Connection PostgreSQL Server Machine Software Installed/Configuration PostgreSQL Software (ver. 8.0 or later) NVBU Server/Client Software Plug-in for PostgreSQL NVBU Server Machine Software Installed/Configuration NVBU Server software PostgreSQL Server Added as a NVBU Client (For complete details on adding a Client machine to the NVBU Server, refer to the Quest NetVault Backup Administrator s Guide) Important: Regardless of the configuration that you use (that is, separate NVBU Sever and PostgreSQL server, vs. a single machine configured as both), the plugin must be installed on the host on which PostgreSQL resides. Sample images and procedures throughout this guide assume that you are using this two-machine environment and that configuration requirements have been met Installing the Plug-in To install Plug-in for PostgreSQL, perform the following steps: 1. From the NVBU Console on the NVBU Server, open the NVBU Client Management window (via either of the toolbar buttons or by clicking Administration > Client Management). 2. In the Clients list, right-click the NVBU Client on which the plug-in is to be installed, and select Install Software. 3. On the dialog that appears, navigate to the location of the.npk installation file for Plug-in for PostgreSQL (on the installation CD or the directory to which the file was downloaded from Quest Software s web site) Based on the operating system, the directory path for this software may vary on the installation CD. 4. Select the file entitled pos-x-x-x-x.npk (where xxxx represents the platform and version number), and click Open. The installation process will occur automatically.

11 Quest NetVault Backup Plug-in for PostgreSQL User s Guide When the Install Software dialog appears that indicates the software was successfully installed, click OK to dismiss it Removing the Plug-in To remove the plug-in, perform the following steps: 1. From the NVBU Console, open the NVBU Client Management window. 2. On the Clients tab, right-click the machine that houses the plug-in (that is, the one configured as the PostgreSQL Server), and select Remove Software. 3. On the Remove Software dialog, select Plug-in for PostgreSQL, and click Remove. 4. When the next Remove Software dialog appears, click OK to proceed (or Cancel to abort). 5. When the confirmation message appears that indicates the software was removed, click OK to close the dialog and return to the NVBU Client Management window. You can also use the NVBU Configurator to remove the plug-in. For more information, refer to the applicable topic in the Quest NetVault Backup Configuration Guide.

12 12 Chapter 2 Installing and Removing the Plug-in

13 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 13 Chapter 3: CONFIGURING THE PLUG-IN Adding a Database Cluster Correcting Invalid Parameters Reconfiguring an Added Database Cluster Removing an Added Database Cluster Setting Default Action for an Error Condition Accessing the Configure Dialog from the Client Management Window Accessing the Configure Dialog from the Configurator Adding a Database Cluster To begin using Plug-in for PostgreSQL for backup and restore, you must first add the target database cluster to the plug-in. If you are running more than one database cluster, follow this procedure for each database cluster to be protected using the plug-in. 1. From the NVBU Console on the NVBU Server, open the NVBU Backup window (via either of the toolbar buttons or by clicking Operations > Backup). 2. On the Selections tab, open the NVBU Client on which the plug-in is installed. To open any node on the Selections tab, do either of the following: Double-click the node. Right-click the node, and select Open. 3. In the list of plug-ins, right-click Plug-in for PostgreSQL, and select Add Database Cluster. 4. Set the various parameters: Database Cluster Name Enter a name for the database cluster. For easy identification, Quest Software recommends that you specify the actual PostgreSQL cluster name. When adding more than one cluster, ensure that a unique name is used for identification. Port This field is preconfigured to port 5432, which is the default listener port for PostgreSQL. Enter the correct port number in this field, if PostgreSQL is configured to listen on any other port. When adding multiple database clusters, ensure that a different listener port is configured for each cluster.

14 14 Chapter 3 Configuring the Plug-in Database SuperUser This field defaults to the superuser postgres. You can enter a different user with superuser privileges for the plug-in s use. Password Enter the password associated with the user specified in the preceding field PostgreSQL Bin Directory Enter the complete path to the PostgreSQL bin directory. For example, this path will be C:\Program Files\PostgreSQL\8.2\bin for a default installation of PostgreSQL ver. 8.2 on the Windows platform. PostgreSQL Library Directory or Path (Linux/UNIX-based systems only) Enter the complete path to the directory that contains the libpq.so file or to the file itself (for example, /usr/lib/libpq.so.5.0). PostgreSQL Data Directory Specify the complete path to the directory that contains the configuration files postgresql.conf, pg_hba.conf, and pg_ident.conf. By default, PostgreSQL stores the configuration files in the data directory. For example, this path will be C:\Program Files\PostgreSQL\8.2\data for a default installation of PostgreSQL ver. 8.2 on the Windows platform. Database Used for Initial Connection For the plug-in's initial connection, the postgres database is used by default. To use a different database for connecting to the server, specify the database name in this field. Template Database Used During Create Database The template specified in this field will be used for creating an empty database during the restore process. Quest Software recommends that the default template0 be used. Backups are performed relative to template0. This means that any languages, procedures added to template1 will be included in the backup. As a result, if you are using customized template1, you must create the database from a truly empty template such as template0. Otherwise, errors due to duplicate definitions are likely to occur during the restore process. Default Character Set From the list, select the Character Set Encoding that the plug-in will use to correctly display the names of databases and tables in the set locale. The following table lists the supported encodings. Note that if an incompatible encoding is configured, you will not be able to browse the tree, or perform backups or restores. Character Set Encoding Language BIG5 Traditional Chinese EUC_CN Simplified Chinese EUC_JP Japanese

15 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 15 Character Set Encoding Language EUC_KR Korean EUC_TW Traditional Chinese GB18030 Simplified Chinese LATIN1 English French German SQL_ASCII Any SJIS Japanese UTF8 Any Important: The UTF8 and SQL_ASCII encodings can be used with any language, however, the support is limited to ASCII character set. If the database or table names contain non-ascii characters, you must set a locale-specific encoding (for example, EUC_JP for Japanese). Following is what the PostgreSQL Documentation states as the limitation of Locale Support: Although PostgreSQL lets you specify any encoding for a database regardless of the locale initialized by initdb, this apparent flexibility does not always work. It would not be correct to choose an encoding not expected by the locale you have selected for the database cluster. The LC_COLLATE and LC_CTYPE settings are determined at initdb time and cannot be changed without repeating initdb, and locale-dependent operations are likely to misinterpret data that is in an incompatible encoding. 5. Click OK to save the settings. Plug-in for PostgreSQL will verify the values specified and add the database cluster if all parameters are properly configured. An error message will appear if an invalid entry is found. You can choose to ignore this message and click Save to add the database. The database cluster will be added, however, note the following: If the superuser name or password cannot be validated, further access will be denied. If the PostgreSQL Data Directory is invalid (while all other parameters are correctly configured), the backups of databases will be completed successfully but the backups of Configuration Files will fail. If the PostgreSQL Bin Directory is invalid (while all other parameters are correctly configured), you will be able to submit a job but the actual job will fail. Refer to the following section to re-configure the parameters if an error occurs while adding a database cluster.

16 16 Chapter 3 Configuring the Plug-in Correcting Invalid Parameters Figure 3-1: Sample error message While adding a database cluster, if a parameter is not correctly configured, an error message showing the details will appear. You can choose to ignore this message and save the information. However, as mentioned in the previous section, further access will be denied or the jobs will not complete successfully till you correct the error. To reconfigure the parameter, perform the following steps: 1. Click Re-configure in the error window. The Add Database Cluster window will appear displaying all the previously configured settings. 2. Specify the correct value for the parameter(s) reported as invalid. For details, refer to the previous section. The password field will appear blank. If the previously configured password is correct, you do not have to re-enter the password; the plug-in will use the cached old password for authentication when this field is left blank. Otherwise, enter the correct password in this field. 3. Click OK to re-configure the parameters Reconfiguring an Added Database Cluster To reconfigure the parameters for a previously added database cluster, perform the following steps: 1. With the Backup window open, locate the PostgreSQL server in the Selections tab and open it. 2. Locate Plug-in for PostgreSQL in the list and double-click it (or right-click and select Open). This will list all the previously configured database clusters. 3. Right-click the target database cluster, and select Configure. The Configure Database Cluster window will appear displaying the current settings for the database cluster. 4. Re-configure the parameters as required. For information on various fields in this window, see Adding a Database Cluster. Note the following: The Database Cluster Name cannot be changed.

17 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 17 The password field will appear blank. If the previously configured password is still valid, you do not have to re-enter the password; the plugin will use the cached old password for authentication when this field is left blank. Otherwise, enter the correct password in this field. 5. Click OK to save the changes and close the window. Important: If the password for the configured superuser is changed in the PostgreSQL database, you must update the password in the plug-in Removing an Added Database Cluster To remove an added database cluster, perform the following steps: 1. With the Backup window open, locate the PostgreSQL server in the Selections tab and open it. 2. Locate Plug-in for PostgreSQL in the list and open it. This will list all the previously configured database clusters. 3. Right-click the target database cluster node, and select Remove. In the confirmation window that appears, click OK. Important: The Plug-in for PostgreSQL node will remain in an Open state even when the last Database Cluster is removed. To close this node and access the other plugins in the open Backup window, double-click the plug-in node or rightclick and select Close Setting Default Action for an Error Condition The plug-in allows you specify what action a backup job should take if it is unable to back up all the selected items (for example, a manually selected database or table is inaccessible during backup). You can specify: Whether the backup should complete but issue warnings, complete without issuing warnings, or fail Whether the items backed up successfully be retained or discarded Additional methods of launching the Configure dialog are later in this section. Note: You can overwrite these default settings on a per-job basis in the Backup Options tab. To configure default actions for all backup jobs, perform the following steps: 1. From the NVBU Console on the NVBU Server, open the NVBU Backup window (via either of the toolbar buttons or by clicking Operations > Backup).

18 18 Chapter 3 Configuring the Plug-in 2. On the Selections tab, open the NVBU Client on which the plug-in is installed. To open any node on the Selections tab, do either of the following: Double-click the node. Right-click the node, and select Open. 3. In the list of plug-ins, right-click Plug-in for PostgreSQL, and select Configure. 4. In the window that appears, you can configure the default action for the following error conditions: Manually Selected Database Unavailable This will occur when an individual database that was manually selected (that is, explicitly clicked) for inclusion in the backup is unavailable for backup for any reason, such as being dropped since the backup job was defined. Manually Selected Table Unavailable This will occur when an individual table that was manually selected (that is, explicitly clicked) for inclusion in the backup is unavailable for backup for any reason, such as being dropped since the backup job was defined. Failed to Backup Configuration Files This will occur when a Configuration File is not found or cannot be backed up for any other reason. Because the pg_hba.conf file is used for user authentication, if this file is missing during job execution, the backup will fail because of logon failure (regardless of the action set for the Failed to Backup Configuration Files error condition). Plug-in for PostgreSQL can take one of following possible courses of action when any of the preceding error conditions occur: Complete with Warnings - Saveset Retained The job will return a status of Backup Completed With Warnings and a backup saveset will be created comprised of the items that were successfully backed up. Complete without Warnings - Saveset Retained The job will complete and return a status of Backup Completed, that is, while errors are logged in the NVBU binary logs, the errors will essentially be ignored in the Job Management window and a backup saveset will be created comprised of the items that were backed up successfully. Fail - Saveset Retained The backup job will return a status of Backup Failed. However, a backup saveset will be generated comprised of the items that were successfully backed up. Fail - No Saveset Retained The backup job will return a status of Backup Failed and no saveset of backed up objects will be kept (that is, even if some of the selected objects were actually successfully backed up, it will be discarded).

19 Quest NetVault Backup Plug-in for PostgreSQL User s Guide To set a default action, select it from the list. For each condition, the action must be set individually. 6. Click OK to save the settings Accessing the Configure Dialog from the Client Management Window To access the Configure dialog from the Client Management window, perform the following steps: 1. From the GUI on the NVBU Server, open the Client Management window (via either of the toolbar buttons or by clicking Administration > Client Management). 2. In the Clients frame, locate the machine that contains the plug-in to be configured, right-click it, and select Configure. This will launch the Remote Configurator window. 3. Click the Plugin Options tab in the Configurator window, and then click the PostgreSQL APM tab. 4. Continue from Step 4 under Setting Default Action for an Error Condition Accessing the Configure Dialog from the Configurator To configure default settings using the Configurator, perform the following steps: 1. Launch the Configurator on the Server. 2. Click the Plugin Options tab. 3. Then click the PostgreSQL APM tab. 4. Continue from Step 4 under Setting Default Action for an Error Condition.

20 20 Chapter 3 Configuring the Plug-in

21 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 21 Chapter 4: BACKING UP DATA Defining a Backup Strategy Supported Backup Formats Available Backup Types Backup Strategy Considerations Example Backup Sequences Backing Up Data with the Plug-in Selecting Data for Backup Choosing Backup Type and Format Setting Backup Options Specifying Action for an Error Condition Finalizing and Submitting the Job Backing Up Global Objects Only Backing Up Configuration Files Important: On Windows, appropriate encoding must be used during database cluster initialization (that is, when you execute initdb). The backups will fail if the UTF-8 encoding is used and the database or table names contain non-ascii characters Defining a Backup Strategy A well-designed backup strategy helps you recover from the damages caused by failure, and resume normal operations as quickly as possible. Before commencing with database backups, ensure that you have a good backup strategy that will safeguard data against media failure, data corruption, user error, and loss of the database server. This section provides information that will help you devise a backup strategy for use with Plug-in for PostgreSQL Supported Backup Formats Plug-in for PostgreSQL supports backups in Plain-text SQL Script, TAR Archive, and Custom Archive backup formats, which can be used to back up entire database cluster or individual databases and tables. Plain-text SQL Script This backup format generates a plain-text file that contains the SQL commands required to reconstruct the database to the state it was in at the time of backup.

22 22 Chapter 4 Backing Up Data TAR Archive This backup format generates a TAR archive file that is not compressed. Custom Archive This backup format generates an archive file that is compressed by default. It provides flexibility to select the compression level and can be used for tables that are larger than the maximum file size supported by the operating system. The custom archive format requires the zlib compression library and can be used only on PostgreSQL installations built with this library. Note that, this library is included by default during PostgreSQL installation unless you specify the --without-zlib option. The use of --without-zlib option during installation disables support for Custom Archive backup type. While similar backup options are available with all the three formats, there are minor differences. All the three formats allow you to restore only what is needed as well as restore data to a different cluster or server Available Backup Types Plug-in for PostgreSQL provides the following backup types: Full Database Cluster Backup This backup type will back up all the databases within the Cluster in the selected Backup Format. In addition, it will also include a backup of Global Objects, which will be in the form of a Plaintext Script file, regardless of the backup format specified. The plug-in will automatically include the Configuration Files when the database cluster is selected, however, you can exclude it from the backup if desired. Individual Database/Table Backup This option lets you back up selected databases or tables in the chosen format. It can be used to back up databases that are updated more frequently than others or used as a source when creating test environments. The Global Objects will not be included when the databases or tables are backed up individually. Global Objects This backup type lets you back up the Global Objects only, which can be used to back up the updates made to the database users, groups, and access permissions. Configuration Files Backup The Configuration Files can be backed up with any of the preceding backup types, or separately. The following files are included when you perform the Configuration Files backup using the plug-in: postgresql.conf This is the primary server configuration file that contains all the parameter settings and directives. pg_hba.conf This is used for host-based or client authentication (HBA stands for host-based authentication). pg_ident.conf This file stores ident maps other than sameuser and is used for ident based authentication.

23 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 23 The Configuration File backup is similar to file system backup. This backup can be used to restore the corrupt or lost configuration files, or restore the exact cluster settings to another server Backup Strategy Considerations The following points must be considered while defining the backup strategy: Database size Frequency of updates and changes Off-peak period for full backups Whether some databases are updated more frequently than others Whether changes are confined to a small or large number of tables in a database Available storage space (and future expansion) Answering these questions will help you define the type and frequency of backups that should be implemented Example Backup Sequences Following are few example backup sequences that can be implemented to meet your PostgreSQL database protection requirements. Full Database Cluster Backups Only If update characteristics are similar across multiple databases, Full Database Cluster backups scheduled every night will guarantee data protection up to the previous day. A Full Database Cluster backup will consume large amounts of storage space. However, restores will be easier and quicker as only a single job will be required to restore the entire cluster. Using the Custom Archive backup format will reduce the backup size. Full Database Cluster Backups + Individual Database Backups If some of the databases are updated more frequently than the others, regular Individual Database/Tables backup coupled with periodic Full Database Cluster backup will be an ideal strategy. For example, Full Database Cluster backups can be performed every Sunday night at 11:00 p.m., while Individual Database backups for the databases that are updated frequently can be performed Monday through Saturday at 11:00 p.m. This will guarantee data protection up to the previous day. Backup frequency can be increased to reduce the amount of data loss and Custom Archive format with higher compression level can be used for large databases to reduce the backup size. Databases that are updated less-frequently can be backed up 2-3 times a week or on demand after an update is made.

24 24 Chapter 4 Backing Up Data During restores, the databases that have not been updated since the last backup can be restored from the Full Database Cluster, while the others can be restored from their last individual backup. Even though the backups are quicker, the restores can take longer due to the additional intervention that is required to execute multiple restore jobs. Global Objects Backup Because the individual database backups do not include the global objects, backups of Global Objects can be performed after updates made to the database users, groups, and access permissions so that if required these recent backups can be used instead of Full Database Cluster backups. Individual Database Backups + Global Objects Backup You could have a backup strategy of Individual Database Backups + Global Objects Backup where you back up the Individual Databases according to their update frequency. Databases updated less frequent could be backed up weekly and databases updated frequently could be backed up daily while Global Objects backups can be performed on a weekly or on demand after an update to the database groups, users, and access permissions is made Backing Up Data with the Plug-in The backup procedure is comprised of the steps outlined in the following sections Selecting Data for Backup 1. From the NVBU Console on the NVBU Server, open the NVBU Backup window (via either of the toolbar buttons or by clicking Operations > Backup). 2. On the Selections tab, open the NVBU Client on which the plug-in is installed. To open any node on the Selections tab, do either of the following: Double-click the node. Right-click the node, and select Open. 3. In the list of plug-ins, double-click Plug-in for PostgreSQL to open it. The plug-in will attempt to connect to the database server with the username and password specified in the Configure dialog. Upon successful authentication, the added Database Clusters will be displayed. 4. Open the target database cluster node and you will see two nodes: Configuration Files and All Databases. To make Full Database Cluster backups, do one of the following:

25 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 25 Select the database cluster node. This will include all the databases within the cluster and the configuration files. To back up only the databases without the configuration files, select the All Databases node (or you can also de-select the Configuration Files node after selecting the database cluster node). Any further drill-down is not required as it will be ignored for the Full Database Cluster backup type. The Full Database Cluster backup will also include the Template Databases. To select individual databases or tables, do the following: Open the All Databases node and select the required databases. To include Template Databases in the backup, select the node (for example, template1). For individual table selection, open the database node. Select the database node, which will automatically include all the tables, and then de-select the un-wanted tables to omit them from backup or individually select the required tables. The Template Database nodes can not be opened further a Using Selection Sets A Selection Set lets you save the frequently selected data items in a composite set, which can be easily accessed for future backup jobs. This eliminates the need to manually select these items each time a backup is required. Creating a Selection Set To create a Select Set, perform the following steps: 1. With the desired items selected, click Save As in the Backup Selection Set frame at the bottom of the Selections tab. 2. In the Save Backup Selection Set widow that appears, enter a unique name for the Selection Set. 3. Click OK. Loading a Selection Set To use a Select Set, perform the following steps: 1. Click Load in the Backup Selection Set frame at the bottom of the Selections tab. 2. In the Load Backup Selection Set window that appears, select the required set. 3. Click OK. Selection Sets are not unique to Plug-in for PostgreSQL. For details on their creation and use, refer to the Quest NetVault Backup Administrator s Guide.

26 26 Chapter 4 Backing Up Data Choosing Backup Type and Format After selecting the data for backup, click the Backup Options tab. Select the following options in this tab: Backup Type In the Backup Types frame, select Full Database Cluster or Individual Database/Table backup type, depending on the type of backup to be performed. For more information, see Available Backup Types. Backup Format In the Backup Format frame, select from the following available backup formats: Plain-text SQL Script File TAR Archive File (Uncompressed) Custom Archive File (Compressed) For more information, see Supported Backup Formats. Important: NVBU GUI Limitation on Windows Platform The display in the Backup Format frame will reset to default if you change the backup type after selecting the file format. For example, if the following steps are performed: Select Individual Database/Table in the Backup Types frame. Select TAR Archive File (Uncompressed) or Custom Archive (Compressed) in the Backup Format frame. Change backup type to Full Database Cluster in the Backup Types frame. As soon as you change the Backup Type, the Backup Format will reset to the default option, Plain Text SQL Script. However, this is an incorrect display and a NVBU GUI limitation as the plug-in still uses the previously selected Backup Format internally. To avoid this confusion, select the desired Backup Format explicitly after selecting the Backup Type. A similar problem also surfaces when you try to save a Backup Options set. The Backup Format will reset to the default option Plain Text SQL Script (regardless of the selection you made) as soon as you click OK in the Backup Selection Options Set window. However, the saved Backup Options set will contain your actual selection. Similarly, when you try to load a Backup Options set, the Plain Text SQL Script format will appear as selected, which is incorrect. Internally, the plug-in will use the actual selected Backup Format.

27 4.2.3 Setting Backup Options Quest NetVault Backup Plug-in for PostgreSQL User s Guide 27 Based on the backup format selected, you can set the following options in the Backup Options frame: a Setting Backup Options for Plain-text SQL Script File Format Include Data Only (No Schema Definitions) Select this option to back up only the data without the schema. The data-only restores can only be performed for backups performed with this option selected. Important: The Template Databases will not be included if you choose to back up only data without the schema definitions. Disable Triggers This option is only relevant when creating a data-only dump. Use this option if there are referential integrity checks or other triggers on the tables. This option will temporarily disable triggers on the target tables during restore. Upon successful data restoration, the triggers will be enabled. Include BLOBs Select this option to back up large objects. When this option is selected, all the BLOBs within the selected database will be backed up regardless of whether the associated table is included. This option is not supported on PostgreSQL versions 8.0 and 8.1 and will be disabled if you are running these versions of the database. Include Object Identifiers This option will dump object identifiers (OIDs) as part of the data for every table. Use this option if the OID columns are referenced (for example, in a foreign key constraint). Otherwise, do not select this option. Include Drop Object Commands Select this option to drop and recreate objects during the restore process. Exclude Access Privileges Select this option to prevent dumping of access privileges (grant/revoke commands). Disable $ Quoting for Function Bodies The Disable Dollar Quoting option disables the use of dollar quoting for function bodies, and forces them to be quoted using SQL standard string syntax b Setting Backup Options for TAR Archive Format Include BLOBs Select this option to back up large objects. When this option is selected, all the BLOBs within the selected database will be backed up regardless of whether the associated table is included. This option is not supported on PostgreSQL version 8.1 and will be disabled if you are running this version of the database. Disable $ Quoting for Function Bodies The Disable Dollar Quoting option disables the use of dollar quoting for function bodies, and forces them to be quoted using SQL standard string syntax.

28 28 Chapter 4 Backing Up Data c Setting Backup Options for Custom Archive Format Include BLOBs Select this option to back up large objects. When this option is selected, all the BLOBs within the selected database will be backed up regardless of whether the associated table is included. This option is not supported on PostgreSQL version 8.1 and will be disabled if you are running this version of the database Disable $ Quoting for Function Bodies The Disable Dollar Quoting option disables the use of dollar quoting for function bodies, and forces them to be quoted using SQL standard string syntax. Compression Level Set the compression level to use for the custom archive format. This can be set to any value between 0 and Specifying Action for an Error Condition The plug-in allows you specify what action a backup job should take if it is unable to back up all the selected items (for example, a manually selected database or table is inaccessible during backup). A default action for all backup jobs can be set in the Configure dialog as outlined in Setting Default Action for an Error Condition. If you want to override the default settings for a particular job, set the required option in the fields that are displayed at the bottom of the Backup Options tab. Full Database Cluster Backup For Full Database Cluster backup type, the action can be set for the following scenario: Failed to Backup Configuration Files This will occur when a Configuration File is not found or cannot be backed up for any other reason. Because the pg_hba.conf file is used for user authentication, if this file is missing during job execution, the backup will fail because of logon failure (regardless of the action set for the Failed to Backup Configuration Files error condition). Individual Database/Table Backup For Individual Database/Table backup type, action can be set for the following additional scenarios: Manually Selected Database Unavailable This will occur when an individual database that was manually selected (that is, explicitly clicked) for inclusion in the backup is unavailable for backup for any reason, such as being dropped since the backup job was defined. Manually Selected Table Unavailable This will occur when an individual table that was manually selected (that is, explicitly clicked) for inclusion in the backup is unavailable for backup for any reason, such as being dropped since the backup job was defined.

29 Quest NetVault Backup Plug-in for PostgreSQL User s Guide 29 The plug-in can be configured to take one of following possible courses of action when any of the above listed error condition occurs during the job execution: Complete with Warnings - Saveset Retained The job will return a status of Backup Completed With Warnings and a backup saveset will be created comprised of the items that were successfully backed up. Complete without Warnings - Saveset Retained The job will complete and return a status of Backup Completed, that is, while errors are logged in the NVBU binary logs, the errors will essentially be ignored in the Job Management window and a backup saveset will be created comprised of the items that were backed up successfully. Fail - Saveset Retained The backup job will return a status of Backup Failed. However, a backup saveset will be generated comprised of the items that were successfully backed up. Fail - No Saveset Retained The backup job will return a status of Backup Failed and no saveset of backed up objects will be kept (that is, even if some of the selected objects were actually successfully backed up, it will be discarded) Finalizing and Submitting the Job To finalize and submit a backup job, perform the following steps: 1. Select the Schedule, Target, and Advanced Options tabs, and configure the required options. These options are common to all NVBU Plug-ins. For more information, refer to the Quest NetVault Backup Administrator s Guide. 2. In Job Title, enter a suitable title for the job. Specify a detailed title that lets you easily identify the job for monitoring its progress. 3. Click Submit on the toolbar, or select Accept > Submit Backup. You can monitor the job progress via the NVBU Jobs window and view the logs via the NVBU Logs window. For more information, refer to the Quest NetVault Backup Administrator s Guide.

30 30 Chapter 4 Backing Up Data Backing Up Global Objects Only The Global Objects can be backed up in two ways: Via the Full Database Cluster Backup Type A Full Database Cluster backup performed in any format includes the Global Objects. Because these are cluster-wide and not specific to any individual database, backups of type Individual Database/Table do not include Global Objects. Via the Global Objects Only Backup Type You can also back up the Global Objects separately using the Global Objects Only backup type provided by the plug-in. To create a Global Object Only backup, perform the following steps: 1. Following the steps outlined in Selecting Data for Backup, select the target Database Cluster node. Further drill-down is not required. 2. The Configuration Files will be automatically selected when you select the Database Cluster node. To exclude it from the backup, de-select the Configuration Files node in the Selections tab. 3. On the Backup Options tab, select Global Objects Only Backup type. 4. Set the required action to take if an error occurs during the backup of Configuration Files (if included in the backup). Plug-in for PostgreSQL can be configured to take one of following possible courses of action: Complete with Warnings - Saveset Retained The job will return a status of Backup Completed With Warnings and a backup saveset will be created comprised of the items that were successfully backed up. Complete without Warnings - Saveset Retained The job will complete and return a status of Backup Completed, that is, while errors are logged in the NVBU binary logs, the errors will essentially be ignored in the Job Management window and a backup saveset will be created comprised of the items that were backed up successfully. Fail - Saveset Retained The backup job will return a status of Backup Failed. However, a backup saveset will be generated comprised of the items that were successfully backed up. Fail - No Saveset Retained The backup job will return a status of Backup Failed and no saveset of backed up objects will be kept (that is, even if some of the selected objects were actually successfully backed up, it will be discarded). Because the pg_hba.conf file is used for user authentication, if this file is missing during job execution, the backup will fail because of logon failure (regardless of the action set for the Failed to Backup Configuration Files error condition)