Retired products

Moving the SQL HyperBac index, key and log files

The HyperBac Control Service generates index, key and log files when backup or restore processes are run using the SQL HyperBac file extensions. These files are also used and generated by SQL Storage Compress and SQL Virtual Restore, which also use the HyperBac Compression Engine Components.

Index files

Index files are written by the HyperBac Control Service when SQL HyperBac backups are created, and are deleted at the end of the backup process. If you are using SQL Storage Compress of SQL Virtual Restore, index files are also created for each compressed or virtually restored database, and are required to access those databases. By default, the index files are stored in %ProgramFiles(x86)%\Red Gate\HyperBac\indexes on 64-bit machines and%ProgramFiles%\Red Gate\HyperBac\indexes on 32-bit machines.

Key files

The key files are used by SQL HyperBac, SQL Storage Compress and SQL Virtual Restore to encrypt and decrypt backup files, and by SQL Storage Compress to encrypt and decrypt data and log files. By default the key files are stored in%ProgramFiles(x86)%\Red Gate\HyperBac\keys on 64-bit machines and %ProgramFiles%\Red Gate\HyperBac\keys on 32-bit machines.

Log files

The log files are written by the HyperBac Control Service whenever SQL HyperBac, SQL Storage Compress or SQL Virtual Restore is in use, and include information about service startup and shutdown and operations performed by the service. By default the log files are stored in %ProgramFiles(x86)%\Red Gate\HyperBac\logs on 64-bit machines and%ProgramFiles%\Red Gate\HyperBac\logs on 32-bit machines.

Moving files

The index, key and log files are also used by SQL Storage Compress and SQL Virtual Restore. Any changes you make to these files will also be applied to those programs.

If you need to change the location of any of the files, it is important that you follow these steps:

  1. Ensure that no SQL HyperBac backups are in progress.
  2. If you are using SQL Storage Compress or SQL Virtual Restore, take any compressed or virtually restored databases offline:
    • Right-click each database in SQL Server Management Studio (SSMS), and select Tasks > Take Offline. You may need to run this task twice before SSMS reports the database as being offline.
      or
    • Ensure you are connected to the master database, then run the following T-SQL statement for each database:

      ALTER DATABASE <database name> SET OFFLINE

      You may need to run this statement twice before SQL Server reports the database as being offline.

    Alternatively, stop the SQL Server instance. To do this, right click the instance in SQL Server Management Studio and click Pause followed by Stop, or stop the service in the Windows Services list.

  3. From the system tray, double-click the HyperBac Configuration Manager icon  to open the HyperBac Configuration Manager.
  4. On the General tab, click the stop button to Stop the HyperBac Control Service.
  5. On the Advanced tab, click the browse button next to the Index Path, Encryption Key Path or Log Path as appropriate and select a location.
  6. Click Save.
  7. Move the indexes, keys or logs folder and all of its contents, as appropriate, from the current location to the new location you have specified.
  8. Return to the HyperBac Configuration Manager. On the General tab click the Start button to restart the HyperBac Control Service.
  9. Click Exit to close the HyperBac Configuration Manager.
  10. Bring any SQL Storage Compress or SQL Virtual Restore databases back online. You can do this using the Bring online task in SQL Server Management Studio or by running the following T-SQL statement against the master database for each compressed database:

    ALTER DATABASE <database name> SET ONLINE

Didn't find what you were looking for?