Working with file paths, extensions, and processing options - SQL HyperBac

When you install SQL HyperBac, it is pre-configured with a comprehensive set of default file paths, extensions, and associated processing options (detailed below).

The "Worked example" topics show how with these default settings, you can start using SQL HyperBac's compression and encryption with your backups immediately, with minimal changes to your existing backup procedures.

Before you edit file paths, extensions, and associated processing options, check that the default configuration does not already meet your needs; changes take effect as soon as you confirm them, and are applied to any matching backup, restore, export, and import operations you perform.

Default file path and extension settings for SQL HyperBac

SQL HyperBac is pre-configured to process backup data for the following file paths and extensions:

Adding a file path, extension, and processing options

To add a new file path, extension, and associated processing options:

1. Start HyperBac Configuration Manager (from the Start Menu, select All Programs > Red Gate > HyperBac > HyperBac Configuration Manager), and select the Extensions tab.

   

2. To add a new file path and extension, click Add, then OK to confirm.

   The Add/Modify Registration Wizard is displayed, with the File Path tab selected.

   

3. Adjust the settings in the File Path tab as required:
   • If you want SQL HyperBac to operate with the file extension on any path (globally), select Include All Paths (Local and Remote).

     Note that if you select this option you must also use the Specify File Extension option in step 4.

   • Alternatively, select Specify Path, and type or browse for a specific file path in the File Path box. (File paths can include '*' and '?' wildcards.) SQL HyperBac will operate on files that use this specific path (and extension, if you specify an extension in step 4).

     Optionally, select Include Sub Directories if you also want SQL HyperBac to operate on files within subdirectories of the specified path.

     As a further option, select Exclude Files in the File Path to prevent SQL HyperBac from operating on files located in the root of the specified path, whilst still operating on files within subdirectories.

4. Click Next to select the File Extension tab:

   

   • If you want SQL HyperBac to operate on any file extension within the path you specified in step 3, select Include All Extensions.

     Note that if you select this option you must also use the Specify Path option in step 3.

   • Alternatively, select Specify File Extension, and type the extension in the Extension box, using the format '*.xxx'.

     (The Extension value can also include the first part of the filename, and '*' and '?' wildcards. For example, 'sales20??_*.bak' will match files named 'sales2009_Feb.bak' and 'sales2010_Jan.bak'.)

5. Click Next to select the Compression tab:

   

   • If you want SQL HyperBac to apply compression to backup data for the file extension and path you specified in steps 3 and 4, select Enable HyperBac Integrated Compression.

     The remaining settings control the type of compression that SQL HyperBac will apply. If you don't select one of these settings, the standard SQL HyperBac compression algorithm is used instead. If you want SQL HyperBac to encrypt your backup data as well (step 6), you must use standard compression.

     Select Enable ZIP Compatible Output Format to specify a compression format that is compatible with many third-party compression tools (such as WinZip, WinRAR, and PKZip).

     Select Use HyperBac Fast Compression to reduce the CPU resources used during compression. This algorithm also results in less compression than SQL HyperBac's standard or ZIP-compatible compression. (Note that, if your system is I/O-bound, while writing to disk for example, the fast compression setting may result in longer backup times.)

     Note also, that ZIP-compatible compression and fast compression cannot be used together.

   • Alternatively, select Disable Compression to prevent SQL HyperBac from performing any compression on backup data for the file extension and path you specified in steps 3 and 4.
6. Click Next to select the Encryption tab:

   

   You can specify that SQL HyperBac applies encryption to backup data, independently of the compression settings you chose in step 5.

   • If you want SQL HyperBac to apply AES-encryption to backup data for the file extension and path you specified in steps 3 and 4, select Enable Encryption, and choose an Encryption Level from the list.

     You cannot specify encryption if you have already selected ZIP-compatible compression in step 5.

     If you are encrypting backup data, it is essential that you understand how SQL HyperBac uses key files (the files that act as your "password" for accessing encrypted backups), and that you back up and manage your key files appropriately.

     Read Managing key files for encrypted backups for important information about how to manage your key files.

   • Alternatively, select Disable Encryption to prevent SQL HyperBac from performing any encryption on backup data for the file extension and path you specified in steps 3 and 4.
7. Click Next to select the Format tab:

   

   In this release of SQL HyperBac, only the Backup Format Only option is valid. You don't need to adjust any other options on this tab.

8. Click Next to select the Affinity tab:

   

   If you are using a multi-processor server, you can specify which processors are used during SQL HyperBac operations on backup data for the file extension and path you specified in steps 3 and 4.

   To do this, select Enable Processor Affinity, and then select the required CPUs to use for SQL HyperBac operations from the CPU Affinity Mask list.

   Note that applying CPU affinity to SQL HyperBac operations can prolong backup and recovery operations in some circumstances, so you should use processor affinity settings with care.

9. Click OK, then Yes to confirm your edits.

   The new file path, extension, and other settings, are passed to the SQL HyperBac Control Service. Note that there may be up to a 30 second delay before the service begins to act on the updated settings.

10. Click Save, then, if you've no further changes to make, click Exit to close the HyperBac Configuration Manager.

    The HyperBac Control Service will continue to run in the background.

Modifying a file path, extension, and processing options

To modify a file path, extension, and associated processing options, follow the steps shown above, but in step 2:

1. Select an existing path and extension from the list.
2. Click Modify.

Deleting a file path, extension, and processing options

To delete a file path, extension, and associated processing options:

1. Start HyperBac Configuration Manager (from the Start Menu, select All Programs > Red Gate > HyperBac > HyperBac Configuration Manager), and select the Extensions tab.

   

2. Select the path and extension you want to delete from the list.
3. Click Delete, and then Yes on the confirmation dialog.

   The path and extension you selected (and the associated processing options) are removed from the list, and this change is passed to the HyperBac Control Service. Note that there may be up to a 30 second delay before the service begins to act on the updated settings.

4. If you've no further changes to make, click Exit to close the HyperBac Configuration Manager.

   The HyperBac Control Service will continue to run in the background.