Working with file paths, extensions, and processing options - SQL Storage Compress

SQL Storage Compress advanced configuration

Important: Be careful when editing file paths, extensions, and processing options. If you mis-configure the software, you may be unable to access your SQL Storage Compress databases.

Note also, that if you modify the default file extensions, the SQL Storage Compress application may display inaccurate information about whether databases are compressed, and about the potential space savings you may achieve.

SQL Storage Compress is pre-configured so that you can start using it immediately to create and use compressed or encrypted databases. It is unlikely that you will need to make any configuration changes.

To determine whether or not to intercept restore operations or read and write requests from the SQL Server instance, the HyperBac Control Service checks the file path and file extension associated with each request.

The HyperBac Control Service matches the file path and extension against values stored in a plain-text configuration file (located at \Program Files\Red Gate\HyperBac\bin\hyperbac.conf by default). The configuration file also includes details of the type of processing that the HyperBac Control Service should apply (for example, compression or encryption).

If you do need to view or edit the configuration data, you can use the HyperBac Configuration Manager application. Changes you make using this application are written to the hyperbac.conf configuration file.

Any changes you make to the configuration data take effect almost immediately; there may be up to a 30-second delay before SQL Storage Compress starts to use the new configuration.

Note: you should always use the HyperBac Configuration Manager application to edit the configuration data for file paths and extensions. Do not edit the hyperbac.conf file directly unless specifically directed (for example, to add a "VirtualDiskSize" parameter, as described in Preventing "Insufficient free space" errors).

Default file extensions recognized by SQL Storage Compress

By default, SQL Storage Compress recognizes online database files on any path with the following extensions, and applies the processing shown:

By default, SQL Storage Compress also recognizes backup files on any path with the following extensions, and applies the processing shown when reading the backup files during a restore process:

Note that when using the SQL Storage Compress wizard, SQL Backup Pro backup files will be detected and processed correctly, even if they don't use the standard *.sqb file extension.

Adding a file path, extension, and processing options

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

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

   

   Extensions are shown in red if the HyperBac Control Service is not licensed to write to them. The HyperBac Control Service can read from all extensions, irrespective of licensing.

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 Storage Compress 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 Storage Compress 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 Storage Compress to operate on files within subdirectories of the specified path.

     As a further option, select Exclude Files in the File Path to prevent SQL Storage Compress 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 Storage Compress 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 Storage Compress to work with compressed 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 Storage Compress will use. If you don't select one of these settings, the standard SQL HyperBac compression algorithm is used instead. If you want SQL HyperBac to work with encrypted 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 Storage Compress's standard or ZIP-compatible compression.

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

   • Alternatively, select Disable Compression to prevent SQL Storage Compress from using compression on 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 Storage Compress works with encrypted data, independently of the compression settings you chose in step 5.

   • If you want SQL Storage Compress to use AES-encryption with 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 or no compression in step 5.

     If you are working with encrypted data, it is essential that you understand how SQL Storage Compress uses key files (the files that act as your "password" for accessing encrypted data).

     Read Working with key files for encrypted data for important information about how to manage your key files.

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

   

   • To specify that SQL Storage Compress works with the extension as a backup file (that is, a file used during a RESTORE operation to create a compressed database), select Backup Format Only. Leave the check boxes unselected.
   • To specify that SQL Storage Compress works with the extension as an online database file (data file or log file), select Online Compressed Format. Leave the checkbox unselected.
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 Storage Compress operations on 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 Storage Compress operations from the CPU Affinity Mask list.

   Note that applying CPU affinity to SQL Storage Compress operations can prolong 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 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. 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 the HyperBac Configuration Manager (from the Start Menu, select All Programs > Red Gate > HyperBac > HyperBac Configuration Manager), and select the Extensions tab.

   

   Extensions are shown in red if the HyperBac Control Service is not licensed to write to them. The HyperBac Control Service can read from all extensions, irrespective of licensing.

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.