Product Documentation

Database Administrator's Guide

Previous Topic

Next Topic

ctrdmp - Backup Restore or System Rollback

Used to restore backups created with ctdump.

Operational Model:



ctrdmp [ dumpscript ] [ -x ]

  • dumpscript - The name of a valid dynamic dump restore script
  • -x - Read dump stream from stdin

A successful ctrdmp completion always writes the following message to CTSTATUS.FCS:

DR: Successful Dump Restore Termination

A failed ctrdmp writes the following message to CTSTATUS.FCS when ctrdmp terminates normally:

DR: Dump Restore Error Termination...: <cterr>

where <cterr> is the error code.

When the -x option is specified, the !DUMP keyword in the dump script is ignored and the dump stream is read from standard input.

This might be combined with the ctdump output redirection to pipeline a backup and restore operation:

ctdump -s FAIRCOMS -u admin -p ADMIN -t test6.dmp -c -x| ctrdmp test6.dmp -x

Note: If an error occurs during the restore phase, no backup exists on disk.

If encrypted files are being restored and input redirection is used, ctrdmp is not able to prompt for the master password during the recovery phase of the restore. In this case, an alternate means of providing the master password is required, such as using the CTREE_MASTER_KEY_FILE environment variable.

If for some reason ctrdmp terminates prematurely (for example, a fatal error causes ctrdmp to terminate abnormally), the “Dump Restore Error Termination...” message might not be written to CTSTATUS.FCS. In that case, ctrdmp might have written error messages to standard output or to CTSTATUS.FCS before terminating that helps explain the reason for ctrdmp terminating prematurely.

Note: A 32-bit ctrdmp could fail with error 75 if run on transaction logs created by a 64-bit FairCom Server, which might support more than 2048 connections.

The ctfdmp, ctldmp, and ctrdmp utilities display the FairCom DB version used to compile them when they are run.

Dump and Restore Version Compatibility

The ctrdmp (ctrdmp - Backup Restore or System Rollback, Backup Restore Utility) utility is used to restore (FairCom Database Restore Guide, FairCom Database Restore Guide) a Dynamic Dump and the ctfdmp utility can be used to roll forward (FairCom Database Forward Roll Guide, FairCom Database Forward Roll Guide). Occasionally an update to the FairCom Database Engine may cause an incompatibility between versions. For this reason you must use the ctrdmp from the same release from which the dump was created. It is important to save a copy of the ctrdmp utility that is compatible with each dump file.

Restore Recovery Options

The ctrdmp utility now supports the RECOVER_DETAILS and RECOVER_MEMLOG transaction recovery options (the same options that FairCom Server supports).

If you specify !RECOVER_DETAILS YES in your dump restore script, ctrdmp will log progress messages to the file CTSTATUS.FCS as it performs its automatic recovery.

Environment Variable for Advanced Encryption Password

If this utility has advanced encryption enabled, it can read an encrypted password file instead of being prompted to enter the master password. To enable this, set the environment variable CTREE_MASTER_KEY_FILE to the name of the encrypted master password file.

ctrdmp supports options to help analyze recovery behavior. The following options behave like their corresponding server configuration options:

  • !DIAGNOSTICS TRAN_RECOVERY logs detailed recovery steps to RECOVERY.FCS.
  • !RECOVER_DETAILS YES logs additional recovery progress messages to CTSTATUS.FCS.

See also