Performing native project database backups with the backup utility

The backup contains an exact copy of the Perforce ALM project directory you specify. By default, the backup is added to a .zip file to compress it. You can optionally skip creating the zip file and create only the directory instead.

Keep the following in mind before running the backup utility:

  • Only run the utility from the ALM Server computer. Attempting to back up databases from a remote computer could cause data loss or corruption.
  • You may need administrative rights to perform the backup (e.g., sudo on Unix or Run as administrator on Windows).
  • During the backup, approximately twice the disk space as the database uses is needed to store temporary files. Make sure there is enough free disk space before backing up.

1. Download the backup utility and save it in the ALM Server application directory. The utility is named ttNativeBackupUtil.exe.

2. Open a command shell or DOS prompt.

3. Change (cd) to the directory that contains the backup utility.

4. Enter the following at the prompt: ttNativeBackupUtil [-d] [-f] [-n] [-t] SourceProject DestinationZipFile

Option Description
-d Only back up the database file without attachments and other external data (e.g., custom report stylesheets, etc.).
-f Overwrite backup.zip if it exists (optional).
-n Do not zip the backup directory (optional).
-t Full or relative path to the directory used for temporary files. Defaults to the operating system temp directory.
SourceProject Full or relative path to the native database directory to back up. Projects are each stored in a subdirectory in the TTServDb directory by default, but they may be stored in other locations depending on your configuration.
DestinationZipFile Full or relative path and file name for the .zip backup file. The .zip extension is automatically added if not included.
To view help for the backup utility, enter ttNativeBackupUtil -h. To view version information, enter ttNativeBackupUtil -v.

Examples

Windows

  • ttNativeBackupUtil.exe "C:\Perforce ALM\TTServDb\TTDbs\Sample Project" C:\MyBackup.zip
  • ttNativeBackupUtil.exe -f MyProject\ C:\MyBackup.zip

Unix

  • ./ttNativeBackupUtil /var/lib/PerforceALM/TTServDb/TTDbs/Sample Project /home/currentUser/mybackup.zip
  • ./ttNativeBackupUtil -f MyProject/ mybackup.zip
  • sudo ./ttNativeBackupUtil -f MyProject/ mybackup.zip (Administrative permissions may be needed to execute this command)