NuoDB Archive - Restoring

In the course of restoring an archive from a hot copy backup set, you can use the nuoarchive restore to:

  • Report on timestamps

  • Restore from hot copy backup set

  • Restore to a specific transaction from a hot copy backup


nuoarchive restore [options] [<nuodb options>] [<location>]


Fully qualified path to the backup set directory.
If you are restoring to a snapshot then this option specifies the path of the archive directory that contains the snapshot you are restoring to.


Restore syntax is:

nuoarchive restore [<restore options>] <location>

Restore Options are:

Display a list of options.

Do not show any output.

Restore into this destination directory.

Restore this snapshot (identified by transaction ID).

Restore the backup set up through this backup element ID.

Report backup element type/ID mappings, in order of newest first.

Report timestamp/transaction ID mappings.

NuoDB Options

Some of the options available to nuodb (the process behind a TE or SM) can also be used with nuoarchive. These are termed nuodb options.

The most common of these is --mem specifying the amount of memory nuoarchive can use.


Restoring Encrypted Archives

If nuoarchive restore detects that the backup set is encrypted, you will be prompted to enter the storage password that was current when the backup set was created. The password will not be echoed to the screen as it is typed.

If you prefer to provide the password non-interactively, you can either use a pipe to send the password via standard input, or else set the storage password in the NUODB_STORAGE_PASSWORD environment variable.

If the password is not correct then nuoarchive will exit.

Report timestamps

NuoDB Archive supports an option called --report-timestamps that can be used to report every transaction that can be restored in a backup set, along with the timestamp at which it was committed. This timestamp was chosen by the TE that performed the commit, and it is chosen at pre-commit time. Timestamps will not appear in strict order when the database contains multiple TEs, instead they will be partially ordered by committing TE.

You may optionally specify a time window of interest to restrict the number of transactions output by this tool. To restrict the lower bound of timestamps, use the --start-time option. To restrict the upper bound of timestamps, use the --end-time option.

Timestamps output by --report-timestamps are in GMT. The timestamps input to --start-time and --end-time must be in GMT and must be in the strict ISO 8601 combined date and time representation, that is, “YYYY-MM-DDTHH:MM:SS”.

For information on NuoDB Archive options relevant to --report-timestamps, see Restore Options.

Restore snapshot

NuoDB Archive supports an option called --restore-snapshot that can be used in conjunction with --restore-dir to restore a transaction. Pass the transaction ID (of the transaction to restore) to --restore-snapshot, and the directory into which the restored archive should be constructed to --restore-dir.

For information on NuoDB Archive options relevant to --restore-snapshot, see Restore Options.

Efficient point-in-time restore

It is important to give NuoDB Archive enough memory during point-in-time restore, especially if the database being restored has large indexes. A simple rule of thumb is to restore on a host that is not currently running a database, and give NuoDB Archive as much memory as is normally given to an SM.

Adjust the amount of memory given to nuoarchive with the --mem option, for example:

nuoarchive restore --mem 20G --restore-dir /volumes/archives/test2 --restore-snapshot 3970 /volumes/backupsets/test-2022-04-22


For examples of using nuoarchive restore, see Restoring Data From Backup Sets.